# Manual

# 1 Overview

This document is intended to act as a user manual and explain WCC Lite usage in detail. It is expected the person referring to this manual is experienced in programmable logic controllers (PLC), networking (IPv4, ethernet) and the use of the operating system of choice (Windows, Linux, Mac, etc.). This document might not cover all of the use cases. For usage not described in this document please contact Elseta technical support (contact info available on the last page of this document).# 2 Hardware and software requirements

In order to get the WCC Lite up and running, a PC/Mac is required, capable of running a web browser and an MS Excel compatible spreadsheet editor (e.g. LibreOffice or an online spreadsheet editor such as Google Sheets). A built­in or external Ethernet adapter is also required to connect to the WCC Lite.# 3 Technical information

<table border="1" id="bkmrk-system-processor-arm" style="border-collapse: collapse; width: 100%; height: 783px;"><tbody><tr style="height: 29px;"><td class="align-center" colspan="2" style="height: 29px; width: 100%;">##### System

</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Processor</td><td style="width: 50%; height: 29px;">ARM CPU (AR9331, 400MHz)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Memory</td><td style="width: 50%; height: 29px;">16 MB Flash/64 MB DDR2 RAM</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Wireless</td><td style="width: 50%; height: 29px;">802.11 b/g/n</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">I/O</td><td style="width: 50%; height: 29px;">1x Binary input (hardware version &gt;=1.4)

1x Relay output

</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Additional storage SD card (2GB by default)</td><td style="width: 50%; height: 29px;">SD card (2GB by default)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Ethernet 10/100 Base­T ­ RJ­45 connector up to 2 independent ports</td><td style="width: 50%; height: 29px;">10/100 Base­T ­ RJ­45 connector up to 2 independent ports</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Serial ports</td><td style="width: 50%; height: 29px;">1x RS­485  
1x RS­485 / RS­232 (switchable)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Time synchronization</td><td style="width: 50%; height: 29px;">NTP client + server, IEC 60870­5­101, IEC 60870­5­104</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">GSM</td><td style="width: 50%; height: 29px;">2G(GPRS, EDGE) / 4G(LTE)  
2G(GPRS, EDGE) / 3G(UMTS, HSDPA, HSUPA)  
2G(GPRS, EDGE) / 3G(UMTS, HSDPA, HSUPA) / 4G(LTE)  
Single OR Dual SIM card modem</td></tr><tr style="height: 29px;"><td class="align-center" colspan="2" style="width: 100%; height: 29px;">##### Power requirements

</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Power supply </td><td style="width: 50%; height: 29px;">12 ­- 24 VDC</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Power consumption </td><td style="width: 50%; height: 29px;">&lt; 6W</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Dimensions </td><td style="width: 50%; height: 29px;">101 (H) x 22.5 (W) x 119 (L), mm</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Mounting </td><td style="width: 50%; height: 29px;">Wall mount, Din rail</td></tr><tr style="height: 29px;"><td class="align-center" colspan="2" style="width: 100%; height: 29px;">##### Environmental

</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Operating temperature</td><td style="width: 50%; height: 29px;">­40°C to +85°C</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Warranty </td><td style="width: 50%; height: 29px;">2 year</td></tr><tr style="height: 29px;"><td class="align-center" colspan="2" style="width: 100%; height: 29px;">##### Software

</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Compatibility with HMI (Human Machine Interface)</td><td style="width: 50%; height: 29px;">Compatible with cloud based SCADA system -CloudIndustries.eu</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Routing</td><td style="width: 50%; height: 29px;">• Isolated LAN interface  
• Isolated LAN interface, but omitted to provide TCP / UDP ports or VPN mergers  
• Routed LAN internet connection masking data for GSM interfaces  
• Secure LAN data transfer via VPN  
• Secure LAN data transmission through VPN access to the Internet  
• Single OR Dual SIM card modem</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Database</td><td style="width: 50%; height: 29px;">• File based database  
• Data buffering in case of network outage</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Data security</td><td style="width: 50%; height: 29px;">• All data between WCC Lite and Cloud based SCADA exchange over secure encrypted VPN tunnel  
• Firewall to prevent intrusion and DoS attacks  
• VPN solution with VPN gateway can be used to manage (configure and update) and monitor VPN and WCC devices  
from a single place</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Device maintenance</td><td style="width: 50%; height: 29px;">It is possible to configure and monitor devices and protocols connected to the WCC Lite through Elseta cloud based SCADA system CloudIndustries.eu or 3rd party SCADAs and see device­based alarms such as communication errors, etc.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Supported protocols</td><td style="width: 50%; height: 29px;">• Modbus master / slave (RTU / ASCII / TCP)  
• M­Bus master (Serial / TCP)  
• IEC 60870­5­ 101 master / slave  
• IEC 60870­5­ 103 master  
• IEC 60870­5­ 104 master / slave  
• IEC 62056­31 master  
• IEC 62056­21 (since v1.2.13)  
• DNP3 master / slave  
• SMA Net  
• DLMS (since v1.3.0)  
• Resol VBus  
• IEC 61499 (since v1.4.0)  
• IEC 61850 master / slave (since v1.5.0)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Supported devices</td><td style="width: 50%; height: 29px;">• Other Elseta products  
• Aurora PV inverters  
• Delta inverters  
• Kaco PV inverters  
• SMA PV inverters  
• Ginlong PV inverters  
• Solplus PV inverters  
• Kostal devices  
• Windlog data logger  
• Vestas Wind turbines  
• Elgama elektronika electricity meters</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Network features</td><td style="width: 50%; height: 29px;">• IPsec  
• OpenVPN  
• xl2tp  
• Firewall  
• Routing  
• RADIUS  
• SNMP  
• ser2net  
• API  
• NTP synchronization</td></tr><tr><td style="width: 50%;">Extra features</td><td style="width: 50%;">• Software update  
• Remote configuration via CloudIndustries.eu  
administration  
• Device fault notifications  
• Internal web page for configuration and diagnostics</td></tr></tbody></table># 4 WCC Lite status indication and control



# 4.1 Status indication

[![Figure 1: Front panel status indication](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601989825830.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601989825830.png)Figure 1: Front panel status indication

# 4.2 Reset button

The reset button is located on the front panel of WCC Lite, to access it, remove a transparent front panel cover. Different time lengths of button pressing call different behavior.

<table border="1" id="bkmrk-pressing-time-descri" style="border-collapse: collapse; width: 100%; height: 87px;"><tbody><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Pressing time</td><td style="width: 33.3333%; height: 29px;">Description</td><td style="width: 33.3333%; height: 29px;">Indication</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Short Press</td><td style="width: 33.3333%; height: 29px;">System reboot</td><td style="width: 33.3333%; height: 29px;">Red STATUS LED starts blinking</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Long press (&gt;3s)</td><td style="width: 33.3333%; height: 29px;">Reset to factory settings</td><td style="width: 33.3333%; height: 29px;">Red STATUS LED turns on</td></tr></tbody></table>

# 5 Installing the WCC Lite



# 5.1 Mounting

To mount the device:

1. Secure the top of the mounting clip onto a DIN rail.
2. Push the bottom of a device forward to fix the clip in place.

To dismount the device:

1. Pull red-colored clip downwards (found at the bottom side of the DIN rail).
2. Pull back the bottom of the device.
3. Pull the device upwards to dismount it.

[![image-1669193856312.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669193856312.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669193856312.png)[![image-1669193865786.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669193865786.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669193865786.png)

Figure 2: WCC Lite DIN rail mounting clip

# 5.2 Power

It is recommended to power WCC Lite from 6W (minimum) 12-24V DC power supply. A full range is 5V to 36V.

[![image-1669193966138.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669193966138.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669193966138.png)

Figure 3: Power input connector

<p class="callout warning">Note: Make sure that the device is compatible with your power source before proceeding! Check the label next to the power connector or on the side of the device.</p>

# 5.3 SIM card slot

WCC Lite has an optional Dual-SIM card modem. To access both SIM cards, remove a transparent front panel cover and press through the marked hole with a small tool until the SIM holder pops out.

[![image-1669194010051.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669194010051.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669194010051.png)

Figure 5: WCC Lite Dual-SIM card slot

# 5.4 Dual-SIM card slot

WCC Lite has an optional Dual-SIM card modem. To access both SIM cards, remove a transparent front panel cover and press through the marked hole with a small tool until the SIM holder pops out.

[![image-1669194054543.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669194054543.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669194054543.png)

Figure 6: WCC Lite Dual-SIM card holder

To insert SIM cards, remove the Dual-SIM holder and fit SIM cards into it. Insert holder with SIM cards into the slot.

<p class="callout info">Note: Be careful when removing or inserting DUAL-SIM holder, as SIM cards can fall out. </p>

<p class="callout info">Note: WCC Lite will automatically detect a SIM card insertion or removal. </p>

# 6 Interfaces

WCC lite supports various interfaces to acquire data and control external circuitry. That includes two serial port interfaces, relay output, digital input, and external cellular connection antenna.

# 6.1 Serial port interfaces

WCC Lite WCC Lite has 2 serial ports (Figure 7). Selectable RS485 (by default) or RS232 interface on PORT1 and RS485 interface on PORT2.

[![image-1669194105015.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669194105015.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669194105015.png)

<span style="color: #e03e2d;">Figure 7: WCC Lite ports </span>

WCC Lite RS485 interface supports baud rates up to 115200 and has an integrated 120 termination resistor. It is recommended to use termination at each end of the RS485 cable. To reduce reflections, keep the stubs (cable distance from the main RS485 bus line) as short as possible when connecting the device. See the typical RS485 connection diagram in figure 8.

<p class="callout info">Note: Double-check if A and B wires are not mixed up.</p>

WCC Lite 3-wire RS232 interface is available on PORT1 and can be selected by the user (see Port settings). Baud rates up to 115200 are supported. See the typical RS232 connection diagram in figure 9.

[![image-1647614290547.png](https://wiki.elseta.com/uploads/images/gallery/2022-03/scaled-1680-/image-1647614290547.png)](https://wiki.elseta.com/uploads/images/gallery/2022-03/image-1647614290547.png)

<span style="color: #e03e2d;">Figure 8: Typical WCC Lite RS-485 connection diagram </span>

[![image-1647614310588.png](https://wiki.elseta.com/uploads/images/gallery/2022-03/scaled-1680-/image-1647614310588.png)](https://wiki.elseta.com/uploads/images/gallery/2022-03/image-1647614310588.png)

<span style="color: #e03e2d;">Figure 9: Typical WCC Lite RS-232 connection diagram </span>

# 6.2 Relay output

WCC Lite integrates 1 signal relay (3-way RO connector) with COM (common), NC (normally closed), and NO (normally open) signals.

[![image-1669194156568.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669194156568.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669194156568.png)

<span style="color: #e03e2d;">Figure 10: Signal relay connector</span>

Maximum switching power is 60W, maximum contact current is 2A, maximum switching voltage is 60VDC/60VAC. The lower is switching power, the higher is the lifecycle of Relay Output.

Relay electrical endurance:

- resistive load, 30VDC / 1A - 30W min. 1x10<sup>5</sup> operations;
- resistive load, 30VDC / 2A - 60W min. 1x10<sup>4</sup> operations.

# 6.3 Digital Input

With WCC Lite hardware version 1.4, a digital input functionality has been introduced. Software configuration guidelines are discussed in the [WCC Lite internal signals section.](https://wiki.elseta.com/books/manual/page/19-wcc-lite-internal-signals) It changes state when the voltage is between 12-48V (The supported range is between 10-60V).

<table border="1" id="bkmrk-input-voltage-12-48-" style="border-collapse: collapse; width: 100%; height: 119.188px;"><tbody><tr style="height: 29.7969px;"><td style="width: 49.9383%; height: 29.7969px;">Input voltage</td><td style="width: 49.9383%; height: 29.7969px;">12-48 VDC (accepts 10-60V)</td></tr><tr style="height: 29.7969px;"><td style="width: 49.9383%; height: 29.7969px;">Protection</td><td style="width: 49.9383%; height: 29.7969px;">±60 VDC reverse polarity protection

Isolated from main logic

</td></tr></tbody></table>

[![image-1669194223199.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669194223199.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669194223199.png)

<span style="color: #e03e2d;">Figure 11: Signal relay connector </span>

# 6.4 GSM

WCC Lite comes with an optional GSM module.  
There are a few hardware configurations available:

- Without GSM modem.
- With single SIM modem (HW version 1.0 - 1.2) - 2G/3G (GPRS, EDGE / UMTS, HSDPA, HSUPA) version - 5.76Mb/s upload, 7.2Mb/s download. UMTS/HSPA bands 900, 2100. GSM bands 900, 1800. Modem chip - Ublox Sara-U270.
- With single SIM modem (HW version 1.0 - 1.2) - 2G/4G (GPRS, EDGE / LTE) Cat 1 version - 10.3Mb/s upload, 5.2Mb/s download. LTE bands 3, 7, 20. GSM bands 900, 1800. Modem chip - Ublox Lara-R211.
- With dual SIM modem (HW version 1.0 - 1.2) - 2G/3G (GPRS, EDGE / UMTS, HSDPA, HSUPA) version - 5.76Mb/s upload, 7.2Mb/s download. UMTS/HSPA bands 900, 2100. GSM bands 900, 1800. Modem chip - Ublox Sara-U270.
- With dual SIM modem (HW version 1.0 - 1.2) - 2G/4G (GPRS, EDGE / LTE) Cat 1 version - 10.3Mb/s upload, 5.2Mb/s download. LTE bands 3, 7, 20. GSM bands 900, 1800. Modem chip - Ublox Lara-R211.
- With dual SIM modem (HW version 1.3 - 1.4) - 2G/3G/4G (GPRS, EDGE / UMTS, HSDPA, HSUPA / LTE) Cat 4 version - 50Mb/s (max) upload, 150Mb/s (max) download. LTE bands 1, 3, 5, 7, 8, 20, 38, 40, 41. GSM bands 3, 8. UMTS bands 1, 5, 8. Modem chip - Quectel EC25-E.

They are based on a mini PCI-e standard connector and compatible with any other device. Check the label on the package for current modifications.

[![image-1669194279091.png](https://wiki.elseta.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669194279091.png)](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669194279091.png)

<span style="color: #e03e2d;">Figure 12: GSM antenna connector</span>

<span style="color: #000000;">Connect an antenna to the SMA connector labeled “ANT1“. Select a good antenna placement spot considering the operation environment and network coverage of your mobile provider in the area. To enable MIMO functionality for 4G (LTE) modems a second antenna should be connected to the SMA connector labeled ”ANT2”.</span>

<p class="callout info"><span style="color: #000000;">4G (LTE) Cat 1 version modem both antennas are used for LTE communication. In such case, an internal WIFI antenna is used. The network can be limited in distance and speed, especially in metal-based panels.</span></p>

Make sure the signal level is over -80dBm to have a stable connection to the network.

# 6.5 Wi-Fi

For hardware versions older than version **1.4**, in case a Wi-Fi connection is needed, connect a Wi-fi antenna to the SMA connector labeled “WIFI“. Select a good antenna placement spot considering the operation environment.

[![image-1693316807761.png](https://wiki.elseta.com/uploads/images/gallery/2023-08/scaled-1680-/image-1693316807761.png)](https://wiki.elseta.com/uploads/images/gallery/2023-08/image-1693316807761.png)Figure 1. Wi-Fi antenna connector (hardware version older than **1.4**)

Newer hardware versions don’t have an option of connecting an external Wi-Fi antenna as MIMO capability for cellular modems has been introduced. In case stronger reach is needed, a user should contact the manufacturer to provide possible solutions.

[![image-1694092887560.png](https://wiki.elseta.com/uploads/images/gallery/2023-09/scaled-1680-/image-1694092887560.png)](https://wiki.elseta.com/uploads/images/gallery/2023-09/image-1694092887560.png)Figure 2. Wi-Fi antenna connector (hardware version newer than **1.3**)

<p class="callout warning">Given that the default hardware configurations are set for GSM on connectors **ANT 1** and **ANT 2**, the Wi-Fi antenna shall remain non-operational in versions exceeding **1.3**. Users are advised to contact the manufacturer before purchasing the product if Wi-Fi functionality is required.  
</p>

<p class="callout info">Make sure the signal level is over -80dBm to have a stable connection to the network.</p>

# 7 Tags

#### Single point

Commonly used in storing digital states single point values have only one bit of information. The value of such tags can be either one or zero. On the internal web of WCC Lite states of this type of tags are shown in colored boxes with customisable label.

<table border="1" id="bkmrk-value-representation" style="border-collapse: collapse; width: 21.421%; height: 87px;"><tbody><tr style="height: 29px;"><td class="align-center" style="width: 27.0269%; height: 29px;">Value</td><td class="align-center" style="width: 50.6905%; height: 29px;">Representation</td></tr><tr style="height: 29px;"><td class="align-center" style="width: 27.0269%; height: 29px;">0</td><td class="align-center" style="width: 50.6905%; height: 29px;"><span style="background-color: #00ff00;">OFF</span></td></tr><tr style="height: 29px;"><td class="align-center" style="width: 27.0269%; height: 29px;">1</td><td class="align-center" style="width: 50.6905%; height: 29px;"><span style="background-color: #ff0000;">ON</span></td></tr></tbody></table>

#### Double point

Double point signals contain two bits of information that allow four different states, therefore they contain additional information compared to single point ones. INDETERMINATE state might, for example, mean that part of the equipment has been turned off or a mechanical part which does the switching has stuck between states. ERROR state might mean that both contacts are connected and there might be a short circuit in the equipment.

<table border="1" id="bkmrk-value-representation-0" style="border-collapse: collapse; width: 22.2872%; height: 145px;"><tbody><tr style="height: 29px;"><td class="align-center" style="width: 25.8708%; height: 29px;">Value</td><td class="align-center" style="width: 55.8928%; height: 29px;">Representation</td></tr><tr style="height: 29px;"><td class="align-center" style="width: 25.8708%; height: 29px;">00</td><td class="align-center" style="width: 55.8928%; height: 29px;"><span style="background-color: #ffff00;">INDETERMINATE</span></td></tr><tr style="height: 29px;"><td class="align-center" style="width: 25.8708%; height: 29px;">01</td><td class="align-center" style="width: 55.8928%; height: 29px;"><span style="background-color: #00ff00;">OFF</span></td></tr><tr style="height: 29px;"><td class="align-center" style="width: 25.8708%; height: 29px;">10</td><td class="align-center" style="width: 55.8928%; height: 29px;"><span style="background-color: #ff0000;">ON</span></td></tr><tr style="height: 29px;"><td class="align-center" style="width: 25.8708%; height: 29px;">11</td><td class="align-center" style="width: 55.8928%; height: 29px;"><span style="background-color: #ffff00;">ERROR</span></td></tr></tbody></table># 8 Internal web page

WCC Lite is configured via an internal web browser, so no additional software is required.

# 8.1 Initial Setup

WCC Lite comes with a static network configuration with its IP set to 192.168.1.1. For initial setup set a static IP address on your computer and connect your network card to the WCC Lite with an ethernet cable.

### 8.1.1 Static IP address setup on Windows

1\. Press Win+R on your keyboard. This will open the run window. Enter *ncpa.cpl* and press OK. This will open the Network Connections window.

[![image-1637917371163.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1637917371163.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1637917371163.png)

2\. Right­-click on the *Local Area Connection* icon, then select Properties

[![image-1689074528373.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689074528373.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689074528373.png)

3\. In the window that opens, click on the *Internet Protocol Version 4 (TCP/IPv4)* (you may need to  
scroll down to find it). Next, click on the Properties button.

[![image-1637918015359.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1637918015359.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1637918015359.png)

4\. In the window that opens, click the Use the following IP address radio button. Fill the following fields and click OK:

- IP address: *192.168.1.2*
- Subnet mask: *255.255.255.0*
- Default gateway: (leave empty)

[![image-1637918059194.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1637918059194.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1637918059194.png)

### 8.1.2 Connecting to an internal web page

If your computer IP address is set up and an ethernet cable is connected, power up the device. Wait a few minutes until the device boots. Then open your web browser and enter the following URL: *http://192.168.1.1/*  
Supported web browsers:

- Google Chrome (recommended)
- Mozilla Firefox
- Internet Explorer 8 or later

[![image-1637918176782.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1637918176782.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1637918176782.png)

Login with the root user:

- *Username*: *root*
- *Password*: *wcclite*

<p class="callout danger">It is recommended to change the password immediately to avoid any unauthorized access.</p>

<p class="callout warning">Before plugging WCC Lite with a static IP address to the local computer network, make sure to check if such address is not already reserved by other devices.</p>

# 8.2 Site layout

[![image-1637918414929.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1637918414929.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1637918414929.png)

It provides the main navigation through the website. Contains the following sections:

- *PROTOCOL HUB*: configuration related to data exchange between WCC Lite and other devices.
- *STATUS:* system information and diagnostics.
- SYSTEM*:* basic system settings such as time setup.
- *SERVICES:* various other services.
- *NETWORK:* network-related settings and services.
- *USERS*: existing user groups and management of their permissions
- *LOGOUT:* user logout.

# 8.3 Protocol Hub

Protocol HUB section stores configuration for every connected device. You can configure it by importing settings from an Excel file.

#### Configuration

[![image-1689075886564.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689075886564.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689075886564.png)

In this tab a user can:

- Import new configuration from Excel file (.xls, .xlsx formats). If any errors in the file are found, the device will not be imported, and importing process will be stopped.
- Import .fboot file for PLC.
- Import IEC61850 Server model file
- Import IEC61850 Client model file
- Download current configuration Excel file.
- Download a template configuration Excel file.

#### Imported Signals

[![image-1637921790318.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1637921790318.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1637921790318.png)

The imported signals section shows basic information about applied configuration. This section is used for viewing only.

#### Event Log

[![image-1637922251841.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1637922251841.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1637922251841.png)

Event Log is the time­stamped status data. It allows reviewing of the latest events and changes for devices state changes in chronological order. Newest events are shown at the top of the list. WCC Lite will time­stamp the status data with a time resolution of one millisecond.

Initially, all breakers, protection contacts digital status input points in the WCCLite; events captured from IEDs (Intelligent electronic devices) shall be configured as Event Log points. It’s possible to assign any digital status input data point in the WCCLite as an SOE point with an Excel template during configuration.

Each time a device changes state, the WCClite will save it with time­tag in internal storage. Event Log can also be downloaded by pressing the download button at the bottom of the page.

<p class="callout info">Events are recorded only for devices that have the *log* field set to 1.</p>

#### Protocol Connections

[![image-1637922438098.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1637922438098.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1637922438098.png)

The protocol connections section shows configured devices and their respective ports, statuses

# 8.4 Status

### Overview

#### System

[![image-1704969826976.png](https://wiki.elseta.com/uploads/images/gallery/2024-01/scaled-1680-/image-1704969826976.png)](https://wiki.elseta.com/uploads/images/gallery/2024-01/image-1704969826976.png)

System section in the status tab shows basic information about the current status of the system.  
<span style="text-decoration: underline;">Hostname:</span> The label that is used to identify the device in the network.  
<span style="text-decoration: underline;">Model:</span> Model of the device.  
<span style="text-decoration: underline;">Firmware version:</span> Current firmware version.  
<span style="text-decoration: underline;">Kernel version:</span> Current kernel version.  
<span style="text-decoration: underline;">Local Time:</span> Current local time.  
<span style="text-decoration: underline;">Uptime:</span> The time a device has been working.  
<span style="text-decoration: underline;">Load average:</span> Measure CPU utilization of the last 1, 5, and 15 minute periods. Load of 0.5 means the CPU has been 50% utilized over the last period. Values over 1.0 mean the system was overloaded.

#### Memory

[![image-1601551636726.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601551636726.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601551636726.png)

The ”Memory” window provides memory usage information on the device.  
<span style="text-decoration: underline;">Total available memory</span>: The amount of available memory that could be used over installed physical memory.  
<span style="text-decoration: underline;">Free</span>: The amount of physical memory that is not currently in use over installed physical memory.  
<span style="text-decoration: underline;">Buffered</span>: The amount of buffered memory that is currently in use for active I/O operations over installed physical memory.

#### Network

[![image-1601551674236.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601551674236.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601551674236.png)

IPv4 WAN, IPv6 WAN status, and active connections of the device.  
<span style="text-decoration: underline;">Type</span>: Type of addressing of IPv4 network interface – DHCP or static.  
<span style="text-decoration: underline;">Address</span>: IP address of the device.  
<span style="text-decoration: underline;">Netmask</span>: Netmask of the device.  
<span style="text-decoration: underline;">Gateway</span>: IP address of the Gateway.  
<span style="text-decoration: underline;">DNS</span>: IP address of DNS server.  
<span style="text-decoration: underline;">Expires</span>: DHCP lease expiration time of the connection.  
<span style="text-decoration: underline;">Connected</span>: The time a device has been connected.  
<span style="text-decoration: underline;">Active Connections</span>: The number of active connections with the device.

#### DHCP leases

[![image-1601551755263.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601551755263.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601551755263.png)

DHCPv4 and DHCPv6 lease expiration time.  
<span style="text-decoration: underline;">Hostname</span>: The label that is used to identify the device in the network.  
<span style="text-decoration: underline;">IPv4-Address</span>: IPv4 address of network interface.  
<span style="text-decoration: underline;">MAC-Address</span>: The media access control address of the IPv4 network interface.  
<span style="text-decoration: underline;">DUID</span>: DHCP Unique Identifier of IPv6 network interface.  
<span style="text-decoration: underline;">Lease Time remaining</span>: The amount of time the device will be allowed connection to the Router.

#### Wireless[![image-1601551793225.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601551793225.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601551793225.png)

WiFi interface information window.  
<span style="text-decoration: underline;">SSID</span>: The sequence of characters that uniquely names a wireless local area network.  
<span style="text-decoration: underline;">Mode</span>: Shows how the device is connected to the wireless network – Master or Client.  
<span style="text-decoration: underline;">Channel</span>: The number of channels and radio frequency for connection to access point.  
<span style="text-decoration: underline;">Bitrate</span>: The number of bits that pass the device in a given amount of time.  
<span style="text-decoration: underline;">BSSID</span>: The MAC address of the wireless access point.  
<span style="text-decoration: underline;">Encryption</span>: Security protocol for the wireless network.

#### Associated stations

[![image-1601551830832.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601551830832.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601551830832.png)List of associated stations (clients).

<span style="text-decoration: underline;">Network</span>: Mode and SSID of network point.  
<span style="text-decoration: underline;">MAC-Address</span>: The media access control address of IPv4 network interface.  
<span style="text-decoration: underline;">Hostname</span>: The label or IP address that is used to identify the device in the network.  
<span style="text-decoration: underline;">Signal/Noise</span>: Received signal level over the background noise level. -30 dBm is the maximum achievable signal strength, -70 dBm is the minimum signal strength for reliable packet delivery in the wireless network.  
<span style="text-decoration: underline;">RX Rate/TX rate</span>: Used measure data transmission in the wireless network over bandwidth. RX Rate represents the rate at which data packets being received by the device, TX Rate represents the rate at which data packets being sent from the device.

#### Board information

[![image-1601551883930.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601551883930.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601551883930.png)Board information provides the following details:  
<span style="text-decoration: underline;">Hardware version</span>: Current hardware version;  
<span style="text-decoration: underline;">Serial number</span>: Serial number of the board;  
<span style="text-decoration: underline;">SoC ID</span>: Unique identifier of CPU unit;

### Firewall

#### IPv4 Firewall

[![image-1601552021522.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552021522.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552021522.png)

Firewall rule list for IPv4 traffic.  
<span style="text-decoration: underline;">Table</span>: The four distinct tables which store rules regulating operations on the packet. Filter concerns filtering rules. NAT concerns translation of source or destination addresses and ports of packages. Mangle table is for specialized packet alteration. The raw table is for configuration exceptions.

<span style="text-decoration: underline;">Chain</span>: The list of rules. Filter table has the following built-in chains: Input – concerns packets whose destination is the firewall itself, Forward – concerns packets transiting through the firewall, Output – concerns packets emitted by the firewall, Reject – reject the packet, Accept – allow the packet to go on its way. NAT table has the following built-in chains: Prerouting – to modify packets as soon as they arrive, Postrouting – to modify packets when they are ready to go on their way. Mangle table has one built-in chain: Forward for transiting packets through the firewall.

<span style="text-decoration: underline;">Pkts</span>.: The packets processed by the firewall.

<span style="text-decoration: underline;">Traffic</span>: The amount of data processed by the firewall.

<span style="text-decoration: underline;">Target</span>: The chain of the table of the firewall.

<span style="text-decoration: underline;">Prot</span>.: The transport layer protocol processed by the firewall.

<span style="text-decoration: underline;">In</span>: The network interface for the input chain processed by the firewall.

<span style="text-decoration: underline;">Out</span>: The network interface for the output chain processed by the firewall.

<span style="text-decoration: underline;">Source</span>: IPv4 address of the device that the packet comes from.

<span style="text-decoration: underline;">Destination</span>: IPv4 address of the device that the packet goes to.

<span style="text-decoration: underline;">Options</span>: The options for configuring the firewall.

#### IPv6 Firewall

[![image-1601552266384.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552266384.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552266384.png)

Firewall rule list for IPv6 traffic.

<span style="text-decoration: underline;">Table</span>: The three distinct tables which store rules regulating operations on the packet. Filter concerns filtering rules. Mangle table is for specialized packet alteration. The raw table is for configuration exceptions.

<span style="text-decoration: underline;">Chain</span>: The list of rules. Filter table has the following built-in chains: Input – concerns packets whose destination is the firewall itself, Forward – concerns packets transiting through the firewall, Output – concerns packets emitted by the firewall, Reject – reject the packet, Accept – allow the packet to go on its way. Mangle table has one built-in chain: Forward for transiting packets through the firewall.

<span style="text-decoration: underline;">Pkts</span>.: The packets processed by the firewall.

<span style="text-decoration: underline;">Traffic</span>: The amount of data processed by the firewall.

<span style="text-decoration: underline;">Target</span>: The chain of the table of the firewall.

<span style="text-decoration: underline;">Prot</span>.: The transport layer protocol processed by the firewall.

<span style="text-decoration: underline;">In</span>: The network interface for the input chain processed by the firewall.

<span style="text-decoration: underline;">Out</span>: The network interface for the output chain processed by the firewall.

<span style="text-decoration: underline;">Source</span>: IPv6 address of the device that the packet comes from.

<span style="text-decoration: underline;">Destination</span>: IPv6 address of the device that the packet goes to.

<span style="text-decoration: underline;">Options</span>: The options for configuring the firewall.

### Routes

[![image-1601552456174.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552456174.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552456174.png)

The routing tables provide information on how datagrams are sent to their destinations.

<span style="text-decoration: underline;">ARP</span>: An address Resolution Protocol which defines how IP address is converted to a physical hardware address needed to deliver packets to the devices.

<span style="text-decoration: underline;">Interface</span>: The type of Network interface. br-lan refers to the virtual bridged interface: to make multiple network interfaces act as if they were one network interface.

<span style="text-decoration: underline;">Network</span>: The type of network through which the traffic will be sent to the destination subnet.

<span style="text-decoration: underline;">Target</span>: An address of the destination network. The prefix /24 refers the subnet mask 255.255.255.0.

<span style="text-decoration: underline;">IPv4-Gateway</span>: IP address of the gateway to which traffic intended for the destination subnet will be sent.

<span style="text-decoration: underline;">Metric</span>: The number of hops required to reach destinations via the gateway.

<span style="text-decoration: underline;">Table</span>: The type of routing tables: main (default), local (maintained by the kernel).

<span style="text-decoration: underline;">IPv6 Neighbours</span>: The devices on the same network with IPv6 addresses.

### System Log

[![image-1601552517322.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552517322.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552517322.png)

System log window shows a table containing the events that are logged by the device. It has the following columns:

- \# (sequence number);
- Time (day of the week, month, day of the month, time and year);
- facility;
- process (who generated the message);
- priority level;
- message.

Messages can be sorted and filtered to extract a particular set of messages. This might be useful when debugging kernel or protocol level problems.

### Kernel Log

[![image-1601552562425.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552562425.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552562425.png)

Kernel log shows a list of the events that are logged by the kernel of the device. Log format: time in seconds since the kernel started and message.

### Processes

[![image-1601552597976.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552597976.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552597976.png)

List of processes running on the system.

<span style="text-decoration: underline;">PID</span>: Process ID.

<span style="text-decoration: underline;">Owner</span>: User to whom the process belongs.

<span style="text-decoration: underline;">Command</span>: Process.

<span style="text-decoration: underline;">CPU usage</span>: It is the CPU usage of the individual process. CPU usage above 90 % is an indicator of insufficient processing power.

<span style="text-decoration: underline;">Memory usage</span>: Memory usage of the individual process.

<span style="text-decoration: underline;">Hang Up</span>: To freeze the process.

<span style="text-decoration: underline;">Terminate</span>: To end the process cleanly.

<span style="text-decoration: underline;">Kill</span>: To end the process immediately.

### Realtime graph

#### Realtime Load

[![image-1601552704789.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552704789.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552704789.png)

CPU utilization graph. Load of 0.5 means the CPU has been 50% utilized over the last period. Values over 1.0 mean the system was overloaded.

#### Realtime Traffic

[![image-1601552745346.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552745346.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552745346.png)

Graphs representing the status of the virtual and physical network interfaces of the device.

<span style="text-decoration: underline;">Inbound</span>: The speed at which the incoming packets arrive at the device.

<span style="text-decoration: underline;">Outbound</span>: The speed of the packets which were originated by the device.

<span style="text-decoration: underline;">Phy. Rate</span>: The speed at which bits can be transmitted over the physical layer.

#### Realtime Wireless

[![image-1601552775159.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552775159.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552775159.png)

WiFi status graph.

<span style="text-decoration: underline;">Signal</span>: Signal strength level.

<span style="text-decoration: underline;">Noise</span>: Noise level.

<span style="text-decoration: underline;">Phy. Rate</span>: The speed at which bits can be transmitted on the physical layer.

#### Active connections

[![image-1601552803957.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552803957.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552803957.png)

Graph representation of active connections with the device.

<span style="text-decoration: underline;">UDP</span>: Transport layer – User Datagram Protocol.

<span style="text-decoration: underline;">TCP</span>: Transport layer – Transmission Control Protocol.

<span style="text-decoration: underline;">Network</span>: Type of the network layer – IPv4 or IPv6.

<span style="text-decoration: underline;">Source, Destination</span>: IP address and the port number.

<span style="text-decoration: underline;">Transfer</span>: The amount of the transferred data in kB and packets.

### GSM status

This page shows all information that is related to the GSM modem.

[![image-1601552902904.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601552902904.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601552902904.png)

#### Hardware info

All static information on the GSM modem.

<span style="text-decoration: underline;">Modem model</span>: Manufacturer and model of present modem.

<span style="text-decoration: underline;">Modem type</span>: Single SIM or Double SIM modem.

<span style="text-decoration: underline;">Supported network modes</span>: Shows which network modes (or their combinations) are supported (e.g. 2G 4G 2G/4G).

<span style="text-decoration: underline;">IMEI:</span> IMEI (International Mobile Equipment Identity number).

#### Network info

All dynamic information on GSM modem and connected network.

<span style="text-decoration: underline;">IMSI</span>: IMSI (International Mobile Subscriber Identity) number related to current SIM card user.

<span style="text-decoration: underline;">ICCID</span>: ICCID (Integrated Circuit Card Identifier) number related to physical SIM card.

<span style="text-decoration: underline;">Registration status</span>: Curren status of network connection.

<span style="text-decoration: underline;">Internet status</span>: Status of connection to the internet ( valid, when gsm-pinger is enabled and can reach provided hosts).

<span style="text-decoration: underline;">Operator</span>: Operator’s name, to which modem is currently connected.

<span style="text-decoration: underline;">Service provider</span>: IMEI (Service provider for SIM card. Data interface: Shows, whether wcc-lite has a data connection through gsm or not (possible values: ”Up”, ”Down”).

<span style="text-decoration: underline;">SIM state</span>: Shows current status of SIM card (needs PIN, needs PUK, not-inserted and etc.).

<span style="text-decoration: underline;">Signal quality</span>: Shows current signal strength value in dBms. The RSSI value is shown, when connected to 2G/3G networks, RSRP-RSRQ values - when connected to 4G network.

<span style="text-decoration: underline;">Radio access tech.</span>: Current radio technology used (2G, 3G, or 4G).

<span style="text-decoration: underline;">Active SIM</span>: Shows which SIM card is active (if the modem is Dual SIM).

<span style="text-decoration: underline;">Roaming status</span>: Current status of roaming (”Off”, ”On”).

Little bars with a percentage at the center-left shows signal strength. It is calculated with the respect to current radio access technology used (RSSI or RSRP). Two buttons at the bottom can reset (cold-reset) modem or manually switch SIM cards (if it is a Dual SIM modem and both cards are enabled).

[![image-1601554364523.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601554364523.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601554364523.png)

<p class="callout info">Signal quality is described in different ways for different types of different mobile services: Received Signal Strength Indication (RSSI) in GSM (2G) and UMTS (3G), the Reference Signal Received Quality (RSRQ) in LTE RAT.</p>

<p class="callout info">The Reference Signal Received Power (RSRP) is a LTE-specific measure that averages the power received on the subcarriers carrying the reference signal. The RSRP measurement bandwidth is equivalent to a single LTE subcarrier: its value is therefore much lower than the total received power usually referred to as RSSI. In LTE the RSSI depends on the currently allocated bandwidth, which is not pre-determined. Therefore the RSSI is not useful to describe the signal level in the cell.</p>

### VNSTAT Traffic monitor

To monitor the traffic of various network interfaces VNSTAT Traffic monitor can be used. Traffic tracking can be useful if the user wants to have precise information on how much data is used because it can have a dependency on data transmission costs, for example, mobile (cellular) data.

#### Graph

[![image-1601554562243.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601554562243.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601554562243.png)

An example graph shows the statistics gathered for two network interfaces. In these graphs:

<span style="text-decoration: underline;">eth1</span>: Network interface (e.g. Ethernet).

<span style="text-decoration: underline;">br-lan</span>: Virtual network interface (bridge).

<span style="text-decoration: underline;">rx</span>: Data packets received by the device.

<span style="text-decoration: underline;">tx</span>: Data packets sent from the device.

#### Configuration

[![image-1689081624381.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689081624381.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689081624381.png)

Interfaces to be monitored can be selected in a configuration screen. It includes all the network interfaces configured in a system. To start or stop monitoring user should either select or unselect the respective checkbox and save settings by pressing Save &amp; Apply.

# 8.5 System

### System

The system tab includes various properties, configurations, and settings of the system and contains the following pages:

[![image-1689082353519.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689082353519.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689082353519.png)

  
• SYSTEM: properties and settings of the system.  
• ADMINISTRATION: settings of the administration for various services.  
• SOFTWARE: settings of the packages.  
• STARTUP: process management.  
• SCHEDULED TASKS: settings of the scheduled tasks.  
• MOUNT POINTS: settings for the mount points.  
• BOARD: board configuration.  
• CERTIFICATE STORAGE: certificate management panel.  
• LED CONFIGURATION: settings for the LEDs.  
• TIME SYNC: time synchronization of WCC Lite  
• BACKUP/FLASH FIRMWARE: management of the configuration files and firmware image upgrade.  
• REBOOT: device reboot page.

#### System

Basic aspects of the device can be configured. These include time settings, hostname, system event logging settings, language and theme selection.

##### **System properties**

##### General Settings

[![image-1689082863834.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689082863834.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689082863834.png)

General settings of the WCC Lite device are defined as follows:  
<span style="text-decoration: underline;">Local Time:</span> Current local time.  
<span style="text-decoration: underline;">Hostname:</span> The label that is used to identify the device in the network.  
<span style="text-decoration: underline;">Timezone:</span> A region of the globe that observes a uniform standard time. The time zone number indicates the number of hours by which the time is shifted ahead of or behind UTC – Coordinated  
Universal Time. Some zones are, however, shifted by 30 or 45 minutes.

##### Logging

[![image-1689082988260.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689082988260.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689082988260.png)

Logging settings of the WCC Lite device are defined as follows:  
<span style="text-decoration: underline;">System log buffer size:</span> The amount of the records before writing these data to the disk.  
<span style="text-decoration: underline;">External system log server</span>: IP address of the server.  
<span style="text-decoration: underline;">External system log server port:</span> An endpoint of communication with the server.  
<span style="text-decoration: underline;">External system log server protocol:</span> A standard that defines how to establish and maintain a network connection: UDP - User Datagram Protocol, TCP - Transmission Control Protocol.  
<span style="text-decoration: underline;">Write system log to file:</span> The name of the file with the path to it.  
<span style="text-decoration: underline;">Log output level:</span> Log output messages can be grouped by their importance to the user. Levels are described in the table below.

<table border="1" id="bkmrk-log-output-level-des" style="border-collapse: collapse; width: 100%; height: 997px;"><tbody><tr style="height: 29px;"><td style="width: 96.8148%; height: 29px;">**Log output level**</td><td style="width: 178%; height: 29px;">**Description**</td></tr><tr style="height: 29px;"><td style="width: 96.8148%; height: 29px;">Emergency</td><td style="width: 178%; height: 29px;">System is unusable</td></tr><tr style="height: 29px;"><td style="width: 96.8148%; height: 29px;">Alert</td><td style="width: 178%; height: 29px;">Action must be taken immediately</td></tr><tr style="height: 29px;"><td style="width: 96.8148%; height: 29px;">Critical</td><td style="width: 178%; height: 29px;">Critical conditions</td></tr><tr style="height: 29px;"><td style="width: 96.8148%; height: 29px;">Error</td><td style="width: 178%; height: 29px;">Error conditions</td></tr><tr style="height: 29px;"><td class="align-left" style="width: 96.8148%; height: 29px;">Warning</td><td style="width: 178%; height: 29px;">Potentially hazardous conditions</td></tr><tr style="height: 29px;"><td style="width: 96.8148%; height: 29px;">Notice</td><td style="width: 178%; height: 29px;">Normal conditions that might need action</td></tr><tr style="height: 31px;"><td style="width: 96.8148%; height: 31px;">Info</td><td style="width: 178%; height: 31px;">Information messages</td></tr><tr style="height: 29px;"><td style="width: 96.8148%; height: 29px;">Debug</td><td style="width: 178%; height: 29px;">Debugging messages</td></tr></tbody></table>

Cron Log Level: Cron has three output levels to choose from to write to its logs. Possible options are  
described in the table below.

<table border="1" id="bkmrk-cron-log-level-descr" style="border-collapse: collapse; width: 100%; height: 116px;"><tbody><tr style="height: 29px;"><td style="width: 36.2962%; height: 29px;">**Cron log level**</td><td style="width: 63.7038%; height: 29px;">**Description**</td></tr><tr style="height: 29px;"><td style="width: 36.2962%; height: 29px;">Debug</td><td style="width: 63.7038%; height: 29px;">Debugging messages</td></tr><tr style="height: 29px;"><td style="width: 36.2962%; height: 29px;">Normal</td><td style="width: 63.7038%; height: 29px;">General administrative messages</td></tr><tr style="height: 29px;"><td style="width: 36.2962%; height: 29px;">Warning</td><td style="width: 63.7038%; height: 29px;">Potentially hazardous conditions</td></tr></tbody></table>

#### Time synchronization

WCC Lite has an NTP client to synchronize date and time with external sources. It is not the only source for synchronization, it can also be done using methods defined in IEC-60870-5 protocols.

[![image-1689083348046.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689083348046.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689083348046.png)

<p class="callout info">Please take care choosing a time sync method. If both NTP and IEC 60870-5 protocol slave interface time sync methods are activated simultaneously, they can interfere if there is a time difference. We strongly recommend to use single time sync method to prevent time interference.</p>

Time synchronization options are defined as:  
<span style="text-decoration: underline;">Enable NTP client:</span> The local time of the device will sync with external time servers.  
<span style="text-decoration: underline;">Provide NTP server:</span> Turn the device into a local NTP server.  
<span style="text-decoration: underline;">NTP server candidates:</span> The network time protocol servers.

##### Language and styles

[![image-1601559832754.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601559832754.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601559832754.png)

Language and Style settings are defined as follows:  
<span style="text-decoration: underline;">Language:</span> The language of the Web interface of the device.  
<span style="text-decoration: underline;">Design:</span> The theme of the Web interface of the device.

#### Administration

##### Administrator Password

[![image-1689083519619.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689083519619.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689083519619.png)

Administrator password can be changed. To change it the combination of digits and letters of the alphabet should be entered and then confirmed in the confirmation field by typing in again.

<p class="callout info">It is advised not to use the default password.</p>

##### Password policy

[![image-1689083560180.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689083560180.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689083560180.png)

For future password changes, user can configurate password policy to create a safer password. Here password requirement can be created such as minimum password length, minimum number of upper or lower case letters, digits and special characters. By ticking the box for checking similar characters, new password will be required to not have repeated characters.

##### SSH Access

WCC Lite has a compact secure shell (SSH) server named Dropbear. Multiple options are available to be changed via WCC Lite web interface, ranging from automatic firewall rules to authentication flexibility.

[![image-1689157365613.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689157365613.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689157365613.png)

Dropbear options are defined as follows:  
<span style="text-decoration: underline;">Interface</span>: Listen only on the given interface or on all, in unspecified.  
<span style="text-decoration: underline;">Port:</span> Specifies the listening port of this interface.  
<span style="text-decoration: underline;">Password authentication:</span> Allow SSH password authentication.  
<span style="text-decoration: underline;">Allow roots logins with password:</span> Allow the root user to login with the password.  
<span style="text-decoration: underline;">Gateway ports:</span> Allow remote hosts to connect to local SSH forwarded ports.

#### SSH-keys

[![image-1601560050675.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560050675.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560050675.png)

SSH keys can be added via WCC Lite web interface. They might be helpful if the user logs into device frequently and does not want to always have to write his credentials.

##### RADIUS Client

[![image-1689157681368.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689157681368.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689157681368.png)

RADIUS client redirects user authorization to remote server, which controls users and their access. A user can add multiple RADIUS clients by clicking add and entering information required.

##### HTTPS certificate

[![image-1601560081935.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560081935.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560081935.png)

WCC Lite by default is shipped with a default certificate for HTTPS connection. This certificate only enables connecting to device via web interface and might cause warnings from a web browser. To eliminate them, user can use his own certificate to secure access to web interface.

User can use certificates uploaded to a certificate storage. It should be noted that only valid certificates with \*.pem extension can be used. Certificate to be used is validated every time device is restarted.  
If validation fails, default certificate is used. This is done to prevent user from losing device access via web interface.  
For new certificate to come to effect user should restart the device.

### Software

Individual packages can be installed via WCC Lite web interface. They can either be installed using web link or selected from the pre-defined feeds.

[![image-1601560319986.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560319986.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560319986.png)

Various options can be selected when installing packages, however, default ones should work well enough and it’s advised to only change them for advanced users.

[![image-1601560339950.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560339950.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560339950.png)

Feeds from which packages are listed for update are defined in Open PacKaGe management (OPKG) configuration that can be changed easily from user interface.

[![image-1601560359726.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560359726.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560359726.png)

Specific distribution feeds can also be added for special cases if standard ones do not fit the needs.

[![image-1601560377187.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560377187.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560377187.png)

### Startup

All of the processes that have init.d scripts can optionally enabled or disabled. This can be very useful if user only intends to use only part of the processes.

[![image-1601560412520.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560412520.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560412520.png)

<p class="callout info">User should not disable processes that are essential for device operation as it can render the device unusable.</p>

[![image-1601560436943.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560436943.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560436943.png)

User can optionally run scripts and programs on device startup by putting them into a /etc/rc.local file. This file can be updated from WCC Web interface.

### Scheduled tasks

[![image-1601560465567.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560465567.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560465567.png)

Various tasks can be scheduled with the system crontab. New tasks can be included by creating and saving new rules conforming to cron rules. WCC Lite accepts full cron configuration functionality.

Example in the pictures shows how to execute the disk usage command to get the directory sizes every 6 p.m. on the 1st through the 15th of each month. E-mail is sent to the specified email address.

### Mount points

#### Global settings

[![image-1689158646715.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689158646715.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689158646715.png)

File system mount point configuration window.  
<span style="text-decoration: underline;">Generate Config:</span> Find all currently attached filesystems and swap and replace configuration with defaults based on what was detected.  
<span style="text-decoration: underline;">Anonymous Swap:</span> Mount swap not specifically configured.  
<span style="text-decoration: underline;">Anonymous Mount:</span> Mount filesystems not specifically configured.  
<span style="text-decoration: underline;">Automount Swap:</span> Automatically mount swap on hotplug.  
<span style="text-decoration: underline;">Automount Filesystem:</span> Automatically mount filesystems on hotplug.  
<span style="text-decoration: underline;">Check filesystems before mount:</span> Automatically check filesystem for errors before mounting.

#### Mounted file systems

[![image-1601560579298.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560579298.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560579298.png)

List of mounted file systems, some of which can be dismounted manually.

#### Mount points

[![image-1601560604355.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560604355.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560604355.png)

List of mount points which can be enabled, disabled or deleted.

#### Swap

Swap section is used to describe the virtual memory that can be used if there’s a lack of main memory. WCC Lite does not use any virtual memory by default.

[![image-1601560651205.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601560651205.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601560651205.png)

<p class="callout info">It should be noted that virtual memory might do a lot of reading and writing operations. As WCC Lite uses SD card as an additional flash memory, it is highly advised to not use swap to reduce wearing.</p>

### Board 

[![image-1689158839403.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689158839403.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689158839403.png)

Here a user can configure PORT1 as RS-485 or RS-232.

### Certificate storage

[![image-1689159555059.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689159555059.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689159555059.png)

This section is intended to upload certificate files and viewing information about them.

### LED configuration

WCC Lite has three LEDs that can be configured: WAN, LAN and WLAN. All of the LEDs have a default configuration which should fit most of the cases.

[![image-1689159741014.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689159741014.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689159741014.png)

All possible LED configuration options: Name: Name of the LED configuration.

<span style="text-decoration: underline;">LED Name</span>: Colour and location of the LED. These can be changed, however, normally they should be left unchanged.

<span style="text-decoration: underline;">Default state of the LED</span>: On/Off.  
<span style="text-decoration: underline;">Trigger</span>: One of the various triggers can be assigned to an LED to changes its states. Possible values are shown in a table below.

Table. Possible trigger for an LED:

<table border="1" id="bkmrk-trigger-type-descrip" style="border-collapse: collapse; width: 100%; height: 267px;"><tbody><tr style="height: 35px;"><td style="width: 42.2222%; height: 35px;">Trigger type

</td><td style="width: 57.7778%; height: 35px;">Description

</td></tr><tr style="height: 29px;"><td style="width: 42.2222%; height: 29px;">none

</td><td style="width: 57.7778%; height: 29px;">No blinking function assigned to LED</td></tr><tr style="height: 29px;"><td style="width: 42.2222%; height: 29px;">defaulton

</td><td style="width: 57.7778%; height: 29px;">LED always stays on</td></tr><tr style="height: 29px;"><td style="width: 42.2222%; height: 29px;">timer

</td><td style="width: 57.7778%; height: 29px;">Blinking according to predefined timer pattern</td></tr><tr style="height: 29px;"><td style="width: 42.2222%; height: 29px;">heartbeat

</td><td style="width: 57.7778%; height: 29px;">Simulating actual heart beats</td></tr><tr style="height: 29px;"><td style="width: 42.2222%; height: 29px;">nand-disk

</td><td style="width: 57.7778%; height: 29px;">Flashed as data is written to flash memory</td></tr><tr style="height: 29px;"><td style="width: 42.2222%; height: 29px;">netdev

</td><td style="width: 57.7778%; height: 29px;">Flashes according to link status and send/receive activity</td></tr><tr style="height: 29px;"><td style="width: 42.2222%; height: 29px;">phy0rx, phy0tx, phy0radio, phy0tpt, phy0assoc

</td><td style="width: 57.7778%; height: 29px;">Flashed on WiFi activity events</td></tr><tr style="height: 29px;"><td style="width: 42.2222%; height: 29px;">usbdev

</td><td style="width: 57.7778%; height: 29px;">Turned on when USB device is connected. Applicable for modems</td></tr></tbody></table>

<span style="text-decoration: underline;">Device</span>: Network interface which is going to be tracked.

### Time sync

[![image-1689159845900.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689159845900.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689159845900.png)

This service syncs WCC Lite time with protocols shown. Here user can also select priority levels of protocols which syncs with WCC Lite.

### Backup/flash firmware

Software update allows to upgrade the software running in WCC Lite. It is recommended to keep the device up to date to receive the latest features and stability fixes.

Backup archives contain complete WCC Lite configuration that can be restored at any time. A file will be downloaded by your browser when creating a backup. This file can be later uploaded to the web page to restore configuration.

<p class="callout warning">Generated backup archive should only be applied to the same firmware version it was generated. Applying backup to a different firmware version might render some parts of operating system unstable or even unusable</p>

[![image-1704970591344.png](https://wiki.elseta.com/uploads/images/gallery/2024-01/scaled-1680-/image-1704970591344.png)](https://wiki.elseta.com/uploads/images/gallery/2024-01/image-1704970591344.png)

<p class="callout info">Since version 1.8.3, user can save network settings before upgrading the firmware, such as firewall settings, traffic rules, interfaces etc. To do so, before upgrading firmware, "Keep only network settings:" box should be checked. </p>

A user can choose to keep existing settings after an upgrade. Marking Keep Settings checkbox preserves files listed in <span style="text-decoration: underline;">/etc/sysupgrade.conf</span> and <span style="text-decoration: underline;">/lib/upgrade/keep.d/</span>. It is advised to do a clean install and use backup files to restore settings later if a user intends to make a major system upgrade.

<p class="callout info">Uploading firmware image, to preserve RAM memory, will stop all Protocol HUB processes. After upload, you will have 2 minutes to proceed with firmware flash or to cancel it. After 2 minutes, firmware file will be deleted and Protocol HUB processes will be restarted.</p>

[![image-1601561479820.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601561479820.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601561479820.png)

A file name /etc/sysupgrade.conf can be updated via WCC Web interface. To preserve additional file user should add them to backup file and press Submit. To get the whole list files that would be backed up press Open list.... It is advised to check it before doing a back-up or an upgrade while keeping settings.

### Reboot

[![image-1601561516242.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601561516242.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601561516242.png)

This reboots the operating system of the device.

# 8.6 Services

Services tab shows the services of the device and contains the following subsections:

[![image-1601563935032.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601563935032.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601563935032.png)

Services tab shows the services of the device and contains the following subsections:

- TELEMETRY AGENT: device telemetry sending to a remote server;
- IPSEC: encrypted virtual private network (VPN) configuration.
- API: application programming interface configuration.
- OPENVPN: shows the open-source software application that implements virtual private network (VPN).
- SER2NET: network-to-serial proxy;

### Telemetry agent

Having data about the device helps to easily maintain it. Telemetry agent gathers information in a compact and easily decodable way. It uses UDP packets therefore only small overhead is introduced.

However, UDP does not guarantee the arrival of sent packets therefore not every message might reach the server saving these messages.

To start using Telemetry agent a user should configure and enable it. Four options are available:

- Enable agent;
- Server address;
- Port (UDP);
- Period (s).

Every time timer of period length expires, a message is sent to a server of configured server if service is enabled .

<p class="callout warning">Telemetry agent doesn’t start as a service if Enable agent checkbox is unchecked.</p>

<p class="callout info">Enabling agent and saving the configuration automatically starts the process with the new configuration.</p>

### IPsec

#### Background

WCC Lite supports ipsec vpn, thus is able to deliver data securely over encrypted link. To establish ipsec vpn, a connection definition must be created by entering appropriate configuration settings.

For advanced connection description auxiliary settings sets can be defined. They can be joined to the connection and can be reusable several times according to the need. Each configuration record is identified by a unique name, which is assigned in time of creation. The following diagram shows relations between connection and auxiliary sets.

[![image-1601564177757.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601564177757.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601564177757.png)

#### Ipsec settings

##### Connection description

Options supported by WCC lite is described below.

<table border="1" id="bkmrk-item-type-descriptio" style="border-collapse: collapse; width: 100%; height: 948.05px;"><tbody><tr style="height: 29.6px;"><td style="width: 20.6173%; height: 29.6px;">Item</td><td style="width: 22.5926%; height: 29.6px;">Type</td><td style="width: 56.7901%; height: 29.6px;">Description</td></tr><tr style="height: 29.6px;"><td style="width: 20.6173%; height: 29.6px;">Gateway</td><td style="width: 22.5926%; height: 29.6px;">string</td><td style="width: 56.7901%; height: 29.6px;">Host name or IP address of the remote peer.</td></tr><tr style="height: 80px;"><td style="width: 20.6173%; height: 80px;">Type</td><td style="width: 22.5926%; height: 80px;">selector</td><td style="width: 56.7901%; height: 80px;">Tunnel mode: full packet encryption, covers host-to-host,

host-to-subnet, subnet-to-subnet situations or transport

mode: ip payload encryption, secures host-to-host data only.

</td></tr><tr style="height: 57.6px;"><td style="width: 20.6173%; height: 57.6px;">Local subnet</td><td style="width: 22.5926%; height: 57.6px;">string</td><td style="width: 56.7901%; height: 57.6px;">Specifies local network, in form network/netmask, for

example 192.168.11.0/24

</td></tr><tr style="height: 29.6px;"><td style="width: 20.6173%; height: 29.6px;">Remote subnet</td><td style="width: 22.5926%; height: 29.6px;">string</td><td style="width: 56.7901%; height: 29.6px;">Specifies remote network at another side of a tunnel.</td></tr><tr style="height: 29.6px;"><td style="width: 20.6173%; height: 29.6px;">Authentication</td><td style="width: 22.5926%; height: 29.6px;">selector</td><td style="width: 56.7901%; height: 29.6px;">Pre-shared key or RSA certificate</td></tr><tr style="height: 29.6px;"><td style="width: 20.6173%; height: 29.6px;">Pre-shared key</td><td style="width: 22.5926%; height: 29.6px;">string</td><td style="width: 56.7901%; height: 29.6px;">Available if Authentication set to Pre-shared key</td></tr><tr style="height: 57.6px;"><td style="width: 20.6173%; height: 57.6px;">Certificate set </td><td style="width: 22.5926%; height: 57.6px;">selector</td><td style="width: 56.7901%; height: 57.6px;">Available if Authentication set to RSA certificate. Selectable

from configured auxiliary set.

</td></tr><tr style="height: 57.6px;"><td style="width: 20.6173%; height: 57.6px;">Phase 1 proposal

(IKE)

</td><td style="width: 22.5926%; height: 57.6px;">selector</td><td style="width: 56.7901%; height: 57.6px;">Authentication-encryption schema, selectable from

configured auxiliary set.

</td></tr><tr style="height: 57.6px;"><td style="width: 20.6173%; height: 57.6px;">Phase 2 proposal

(ESP)

</td><td style="width: 22.5926%; height: 57.6px;">selector</td><td style="width: 56.7901%; height: 57.6px;">Authentication-encryption schema, selectable from

configured auxiliary set.

</td></tr><tr style="height: 35.2px;"><td style="width: 20.6173%; height: 35.2px;">Local ID

</td><td style="width: 22.5926%; height: 35.2px;">string</td><td style="width: 56.7901%; height: 35.2px;">Specifies the identity of the local endpoint

</td></tr><tr style="height: 43px;"><td style="width: 20.6173%; height: 43px;">Remote ID

</td><td style="width: 22.5926%; height: 43px;">string</td><td style="width: 56.7901%; height: 43px;">Specifies the identity of the remote endpoint

</td></tr><tr style="height: 35.2px;"><td style="width: 20.6173%; height: 35.2px;">Key exchange

</td><td style="width: 22.5926%; height: 35.2px;">selector

</td><td style="width: 56.7901%; height: 35.2px;">Sets method of key exchange IKEv2 or IKEv1. Default IKEv2.

</td></tr><tr style="height: 35.2px;"><td style="width: 20.6173%; height: 35.2px;">Exchange mode

</td><td style="width: 22.5926%; height: 35.2px;">selector

</td><td style="width: 56.7901%; height: 35.2px;">Main or aggressive. Available if key exchange is set to IKEv1.

</td></tr><tr style="height: 35.2px;"><td style="width: 20.6173%; height: 35.2px;">Use compression

</td><td style="width: 22.5926%; height: 35.2px;">checkbox</td><td style="width: 56.7901%; height: 35.2px;">If selected a compression ability will be proposed to the peer.

</td></tr><tr style="height: 142.65px;"><td style="width: 20.6173%; height: 142.65px;">DPD action

</td><td style="width: 22.5926%; height: 142.65px;">selector

</td><td style="width: 56.7901%; height: 142.65px;">Controls the use of dead peer detection protocol, values:

- none – default, disables sending of DPD messages.
- clear – the connection closed with no action.
- hold – keeps description, tries re-negotiate connection on demand.
- restart – will try to re-negotiate immediately.

</td></tr><tr style="height: 35.2px;"><td style="width: 20.6173%; height: 35.2px;">DPD delay

</td><td style="width: 22.5926%; height: 35.2px;">string</td><td style="width: 56.7901%; height: 35.2px;">Time interval in seconds between peer check. Default 30.

</td></tr><tr style="height: 57.6px;"><td style="width: 20.6173%; height: 57.6px;">DPD timeout

</td><td style="width: 22.5926%; height: 57.6px;">string</td><td style="width: 56.7901%; height: 57.6px;">Time in seconds after which peer consider to be unusable. IKEv1 only. Default 150.

</td></tr><tr style="height: 35.2px;"><td style="width: 20.6173%; height: 35.2px;">Key lifetime

</td><td style="width: 22.5926%; height: 35.2px;">string</td><td style="width: 56.7901%; height: 35.2px;">Lifetime of data channel in seconds . Default 10800.

</td></tr><tr style="height: 35.2px;"><td style="width: 20.6173%; height: 35.2px;">IKE lifetime

</td><td style="width: 22.5926%; height: 35.2px;">string</td><td style="width: 56.7901%; height: 35.2px;">Lifetime of keying channel in seconds. Default 3600.

</td></tr></tbody></table>

##### Auxiliary settings

Phase 1 proposals - IKE/ISAKMP cipher suite components:

<table border="1" id="bkmrk-item-type-descriptio-0" style="border-collapse: collapse; width: 100%; height: 116px;"><tbody><tr style="height: 29px;"><td style="width: 20.8025%; height: 29px;">Item</td><td style="width: 12.037%; height: 29px;">Type</td><td style="width: 51.7901%; height: 29px;">Description</td><td style="width: 15.3704%; height: 29px;">Note</td></tr><tr style="height: 29px;"><td style="width: 20.8025%; height: 29px;">Encryption algorithm

</td><td style="width: 12.037%; height: 29px;">selector

</td><td style="width: 51.7901%; height: 29px;">Encryption algorithm – 3DES, AES128, AES192, AES256.

</td><td style="width: 15.3704%; height: 29px;">required</td></tr><tr style="height: 29px;"><td style="width: 20.8025%; height: 29px;">Hash algorithm

</td><td style="width: 12.037%; height: 29px;">selector

</td><td style="width: 51.7901%; height: 29px;">Hash algorithm – MD5, SHA1, SHA256, SHA384 or SHA512.

</td><td style="width: 15.3704%; height: 29px;">required</td></tr><tr style="height: 29px;"><td style="width: 20.8025%; height: 29px;">DH exponentiation

</td><td style="width: 12.037%; height: 29px;">selector

</td><td style="width: 51.7901%; height: 29px;">Specifies Diffie-Hellman groups – 1,2,5,14,15,16,18

</td><td style="width: 15.3704%; height: 29px;">required</td></tr></tbody></table>

Phase 2 proposals - ESP cipher suite components:

<table border="1" id="bkmrk-item-type-descriptio-1" style="border-collapse: collapse; width: 100%; height: 116px;"><tbody><tr style="height: 29px;"><td style="width: 20.8025%; height: 29px;">Item</td><td style="width: 12.037%; height: 29px;">Type</td><td style="width: 51.7901%; height: 29px;">Description</td><td style="width: 15.3704%; height: 29px;">Note</td></tr><tr style="height: 29px;"><td style="width: 20.8025%; height: 29px;">Encryption algorithm

</td><td style="width: 12.037%; height: 29px;">selector

</td><td style="width: 51.7901%; height: 29px;">Encryption algorithm – 3DES, AES128, AES192, AES256.

</td><td style="width: 15.3704%; height: 29px;">required</td></tr><tr style="height: 29px;"><td style="width: 20.8025%; height: 29px;">Hash algorithm

</td><td style="width: 12.037%; height: 29px;">selector

</td><td style="width: 51.7901%; height: 29px;">Hash algorithm – MD5, SHA1, SHA256, SHA384 or SHA512.

</td><td style="width: 15.3704%; height: 29px;">required</td></tr><tr style="height: 29px;"><td style="width: 20.8025%; height: 29px;">DH exponentiation

</td><td style="width: 12.037%; height: 29px;">selector

</td><td style="width: 51.7901%; height: 29px;">Specifies Diffie-Hellman groups – 1,2,5,14,15,16,18

</td><td style="width: 15.3704%; height: 29px;">optional</td></tr></tbody></table>

<p class="callout info">The following specification and topology map corresponds to settings used in further configuration walk-through example.</p>

#### Creating a connection description

##### Site-to-Site VPN scenario

[![image-1601565165686.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601565165686.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601565165686.png)

##### VPN connection details

Tunnel: demoo

```demoo
IPSec peer: ipsec.vpn.net
Pre-shared key: thebigsecret
Mode: tunnel
Remote network: 10.10.10.10/24
Local network: 10.10.12.0/24
Local ID: wcclite
IKE authentication: aes256
IKE hash: sha256
IKE DH group: 5 (modp1536)
ESP authentication: aes128
ESP hash: sha1
```

<p class="callout info">If auxiliary data is needed, it is recommended to check or define it first.</p>

##### Creation of Phase 1 proposal

- Enter section “Phase 1 proposals”.
- Create a new record by assigning new name, for example “aes256-sha256-dh5” and click the button “Add”.
- Choose corresponding values: encryption, hash algorithm and DH exponentiation.
- Push “save” to save the data.

[![image-1601568023894.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601568023894.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601568023894.png)

##### Creation of Phase 2 proposal

- Enter section “Phase 2 proposals”.
- Create a new record by assign new name for example “aes128-sha1” and click the button “Add”.
- Choose corresponding values: encryption, hash algorithm.
- Push “save” to save the data.

[![image-1601568071003.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601568071003.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601568071003.png)

##### Creation of tunnel definition

Enter section connections

- Create a new record by assigning new name (e.g.“demo0”) and clicking “Add”.
- Call a detail form by pushing the button “edit”.
- Enter peer address into “Gateway”: “ipsec.vpn.net”.
- Ensure “Type” is set to: “Tunnel”.
- Fill local subnet to: 10.10.12.0/24.
- Fill remote subnet to: 10.10.10.0/24.
- Make sure authentication is set to: “Shared secret”.
- Enter Pre-shared key (PSK): thebigsecret.
- “Phase 1 proposal (IKE)”, choose a value: aes256\_sha256\_dh5.
- “Phase 2 proposal (ESP)”, choose a value: aes128\_sha1.
- Locate combo box “additional field”, select “Local ID”, then set value to: wcclite.
- Push “Save”.

[![image-1601568148856.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601568148856.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601568148856.png)

##### Activating the tunnel

- Return to the section “connections”.
- Check the checkbox “Enabled”.
- Push the button “save &amp; apply”.
- Examine indicator “configured”, it should be “yes”, if not, review settings just entered.
- The tunnel should be prepared for operation and will be established on demand.
- Optionally, it is possible to establish tunnel operation by pressing button “start”.

[![image-1601568201450.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601568201450.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601568201450.png)

### L2TP/IPsec

Because of the lack of confidentiality inherent in the L2TP protocol, it is often implemented along with IPsec. This is referred to as L2TP/IPsec, and is standardized in IETFRFC 3193. The process of setting up an L2TP/IPsec VPN is as follows:

- Negotiation of IPsec security association (SA), typically through Internet key exchange (IKE). This is carried out over UDP port 500, and commonly uses either a shared password (so-called ”pre-shared keys”), public keys, or X.509 certificates on both ends, although other keying methods exist.
- Establishment of Encapsulating Security Payload (ESP) communication in transport mode. The IP protocol number for ESP is 50 (compare TCP’s 6 and UDP’s 17). At this point, a secure channel has been established, but no tunneling is taking place.
- Negotiation and establishment of L2TP tunnel between the SA endpoints. The actual negotiation of parameters takes place over the SA’s secure channel, within the IPsec encryption. L2TP uses UDP port 1701.

When the process is complete, L2TP packets between the endpoints are encapsulated by IPsec. Since the L2TP packet itself is wrapped and hidden within the IPsec packet, no information about the internal private network can be gathered from the encrypted packet. Also, it is not necessary to open UDP port 1701 on firewalls between the endpoints, since the inner packets are not acted upon until after IPsec data has been decrypted and stripped, which only takes place at the endpoints. A potential point of confusion in L2TP/IPsec is the use of the terms tunnel and secure channel. The term tunnel refers to a channel which allows untouched packets of one network to be transported over another network. In the case of L2TP/PPP, it allows L2TP/PPP packets to be transported over IP. A secure channel refers to a connection within which the confidentiality of all data is guaranteed. In L2TP/IPsec, first IPsec provides a secure channel, then L2TP provides a tunnel.

### API

The firmware of the WCC Lite features a built-in API which is accessible via the web interface.

<p class="callout warning">As of version 1.2.11, it does not implement any access restriction features apart from those provided by the firewall functionality.</p>

Individual API endpoints can be enabled or disabled via the web configuration interface at Services-&gt;API.

<p class="callout info">All endpoints are disabled by default.</p>

Available API endpoints are shown in the table below.

Table. Available API endpoints:

<table border="1" id="bkmrk-endpoint-description" style="border-collapse: collapse; width: 100%; height: 290px;"><tbody><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">Endpoint</td><td style="width: 75.1852%; height: 29px;">Description</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/version

</td><td style="width: 75.1852%; height: 29px;">Version of the API

</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/actions

</td><td style="width: 75.1852%; height: 29px;">List of available points</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/syncVersion</td><td style="width: 75.1852%; height: 29px;">Version of the sync service

</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/sync

</td><td style="width: 75.1852%; height: 29px;">Protocol hub configuration sync (name=”file”)\*

</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/syslog

</td><td style="width: 75.1852%; height: 29px;">Prints out the syslog

</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/systemInfo

</td><td style="width: 75.1852%; height: 29px;">General system info

</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/gsmInfo

</td><td style="width: 75.1852%; height: 29px;">GSM modem information

</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/devices

</td><td style="width: 75.1852%; height: 29px;">List of configured devices

</td></tr><tr><td style="width: 24.8148%;">/api/device/info

</td><td style="width: 75.1852%;">Device information (name=”device\_alias”)\*\*

</td></tr><tr><td style="width: 24.8148%;">/api/device/tags

</td><td style="width: 75.1852%;">List of tags on particular device (name=”device\_alias”)\*\*

</td></tr><tr><td style="width: 24.8148%;">/api/device/tag/value

</td><td style="width: 75.1852%;">Tag value (name=”device\_alias”, name=”signal\_alias”)\*\*

</td></tr><tr><td style="width: 24.8148%;">/api/tags

</td><td style="width: 75.1852%;">List of configured tags

</td></tr><tr style="height: 29px;"><td style="width: 24.8148%; height: 29px;">/api/sysupgrade

</td><td style="width: 75.1852%; height: 29px;">Firmware upgrade (name=”file”)\*

</td></tr></tbody></table>

\* Endpoints accepting files

\*\* Endpoints accepting field data

The API accepts data and files as POST requests encoded as ”multipart/form-data”.

### OpenVPN

#### OpenVPN Instances

The primary goal is to get a working WCC Lite tunnel and establish a basic platform for further customization. Most users will require further configuration tailored to their individual needs. If you are creating an OpenVPN server (either type), you must create security certificates using the instructions below. If you are using OpenVPN as a client, the required certificates should have been provided with your configuration details. OpenVPN can be configured either by using WCC Lite Web interface or uploading the OVPN file containing necessary parameters. OpenVPN will automatically attempt to load all \*.conf files placed in the /etc/openvpn folder. Several OpenVPN recipes are suggested containing most used configurations that may only require minor changes. If a user intends setting up OpenVPN without OVPN file, it is highly advised to use these recipes and tweaking them up to individual needs.

[![image-1689162191122.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689162191122.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689162191122.png)

OpenVPN instances page contains parameters to be configured.

<span style="text-decoration: underline;">Enabled</span>: Flag to specify if a particular configuration should be enabled;

<span style="text-decoration: underline;">Started</span>: Specifies if a particular configuration has been started by OpenVPN;

<span style="text-decoration: underline;">Start/Stop:</span> Button to manually start or stop any configured tunnels;

<span style="text-decoration: underline;">Port</span>: Specifies the listening port of this service;

<span style="text-decoration: underline;">Protocol</span>: A standard that defines how to establish and maintain a network connection: UDP - User Datagram Protocol, TCP - Transmission Control Protocol.

More parameters for every instance can be changed by pressing Edit button, configuration can be removed with Delete button. Pressing Edit takes the user to main configuration screen containing the options usually used in particular OpenVPN recipes. To do more specific changes user should further select Switch to advanced configuration.

OVPN files contain configuration in a textual form therefore changing parameters requires having prior knowledge about different OpenVPN parameters. It is advised to used OVPN files, however, if configuration has been pre-built beforehand and is used without further changes.

### ser2net

The ser2net daemon allows telnet and tcp sessions to be established with a device’s serial ports. The program comes up normally as a daemon, opens the TCP ports specified in the configuration file, and waits for connections. Once a connection occurs, the program attempts to set up the connection and open the serial port. If another user is already using the connection or serial port, the connection is refused with an error message.

### SNMP

SNMP (Simple Network Management Protocol) is an internet-standard protocol for managing devices on IP networks. SNMP exposes management data in the form of a hierarchy of variables in a MIB (Management Information Base).  
WCC Lite supports SNMP service which is not added to default build of firmware but can be installed as a module. It enables user to collect data on various parameters of system:  
• CPU time - time spent for calculations of various processes:  
user - time for user processes;  
system - time for system processes;  
idle - time spent idling;  
interrupts - time spent handling interrupts.  
• CPU load average - CPU load average for 1, 5 and 15 minutes respectively;  
• Disk usage:  
total - total amount of storage in the device (in kB)  
available - amount of storage available to store data (in kB)  
used - amount of storage used in the device (in KB)  
blocks used percentage - blocks (sectors) used to store data in a disk (in kB)  
inodes used percentage - the inode (index node) is a data structure in a Unix-style file system that describes a file-system object such as a file or a directory. Each inode stores the attributes and disk block location(s) of the object’s data.  
• Memory usage - RAM usage statistics:  
total - total amount of RAM in the device (in kB);  
available - unused amount of RAM in the device (in kB);  
shared - shared amount of RAM between multiple processes (in kB);  
buffered - refers to an electronic buffer placed between the memory and the memory controller;  
cached - a portion of memory made of high-speed static RAM (SRAM) instead of the slower dynamic RAM (DRAM) used for main memory;  
• Network interfaces:  
MTU - maximum transmission unit to be sent over network;  
speed - rate of network transmission;  
physical address - unique MAC address assigned to a device;  
tx/rx: byte, packet, drop, error count;  
• System properties:  
uptime - time since the device was turned on;  
process uptime - time since the process has been started;  
hostname - a label that is assigned to a device connected to a computer network;  
name - name of the device (if defined);  
location - location of the device (if defined).

# 8.7 Network

[![image-1601981573216.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601981573216.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601981573216.png)

The page shows information about current interface status, its configurations, provides various interface, network properties configuration capabilities and contains the following subsections:  
• INTERFACES: shows information about current interface status, allows to create new and configure them.  
• WIRELESS: shows information about wireless radio stations, covers physical settings of the wireless hardware.  
• DHCP AND DNS: allows management of DHCP and DNS servers.  
• HOSTNAMES: allows management of host names.  
• STATIC ROUTES: allows management of IPv4 and IPv6 static routes.  
• FIREWALL: allows management of firewall zones and various firewall properties.  
• DIAGNOSTICS: provides network diagnostics utilities.  
• GSM: allows management of gsm modem and SIM cards.

### Interfaces

[![image-1601981624366.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601981624366.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601981624366.png)

Current information and status of various network interfaces (GSM, LAN, WAN).  
<span style="text-decoration: underline;">Uptime:</span> Current interface uptime in hours, minutes and seconds.  
<span style="text-decoration: underline;">MAC address:</span> Physical interface address.  
<span style="text-decoration: underline;">RX:</span> Received data in bytes (packet count).  
<span style="text-decoration: underline;">TX:</span> Transmitted data in bytes (packet count).  
<span style="text-decoration: underline;">IPv4:</span> Internet protocol version 4 address.  
<span style="text-decoration: underline;">IPv6:</span> Internet protocol version 6 address.

In addition to the network interface status, several actions may be performed:  
<span style="text-decoration: underline;">Connect/Reconnect:</span> Connect to configured interface network if it does not do it automatically. If it already connected to the network it will be trying to reconnect to it.  
<span style="text-decoration: underline;">Stop</span>: Shutdown interface. If you are connected through this interface the connection may be lost.  
<span style="text-decoration: underline;">Edit:</span> Edit interface settings.  
<span style="text-decoration: underline;">Delete</span>: Delete interface.  
<span style="text-decoration: underline;">Add new interface:</span> Adding new Ethernet, GSM or wireless interface with the custom name, protocol and etc.

<table border="1" id="bkmrk-%C2%A0-etho-eth1-type-sta" style="border-collapse: collapse; width: 100%; height: 145px;"><tbody><tr style="height: 29px;"><td style="width: 30.6172%; height: 29px;">  
</td><td style="width: 36.0494%; height: 29px;">etho</td><td style="width: 33.3333%; height: 29px;">eth1</td></tr><tr style="height: 29px;"><td style="width: 30.6172%; height: 29px;">Type</td><td style="width: 36.0494%; height: 29px;">Static</td><td style="width: 33.3333%; height: 29px;">DHCP</td></tr><tr style="height: 29px;"><td style="width: 30.6172%; height: 29px;">Address</td><td style="width: 36.0494%; height: 29px;">192.168.1.1</td><td style="width: 33.3333%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 30.6172%; height: 29px;">Subnet mask</td><td style="width: 36.0494%; height: 29px;">255.255.255.0</td><td style="width: 33.3333%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 30.6172%; height: 29px;">Gateway</td><td style="width: 36.0494%; height: 29px;">  
</td><td style="width: 33.3333%; height: 29px;">  
</td></tr></tbody></table>

<p class="callout info">Changes will only take effect after device reboots.</p>

Network interfaces can be configured on the common page, which can be accessed through add new interface or edit button.

[![image-1689163491851.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689163491851.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689163491851.png)

The following options can be defined in the interface creation panel: name of the interface, protocol, coverage of a particular interface or bridging with other interfaces. After the general setup is done, more detailed settings can be set.

[![image-1601981923788.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601981923788.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601981923788.png)

General common interface setup panel.

[![image-1601981938817.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601981938817.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601981938817.png)

Advanced common interface setup panel.

[![image-1601981952607.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601981952607.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601981952607.png)

Physical common interface setup panel.

[![image-1601981969125.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601981969125.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601981969125.png)

Firewall common interface setup panel.

[![image-1601981983334.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601981983334.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601981983334.png)

DHCP server general setup panel.

[![image-1601981997552.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601981997552.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601981997552.png)

DHCP server advanced setup panel.

[![image-1601982015776.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601982015776.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601982015776.png)

DHCP server IPv6 settings setup panel.

**GSM**

[![image-1601982038949.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601982038949.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601982038949.png)

General Settings Information tab. Gives you name of physical GSM interface, lets you choose protocol (not recommended!).

<p class="callout info">Note: Make sure you won’t change GSM interface's protocol, which is set by default to WWAN. Changing this parameter will lead to undefined GSM modem behavior.</p>

[![image-1601982122856.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601982122856.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601982122856.png)

Advanced Settings tab enables user to configure advanced settings for mobile communication. It includes the following options:  
<span style="text-decoration: underline;">Bring up on boot:</span> Checkbox to start a GSM interface on startup;  
<span style="text-decoration: underline;">Use built-in IPv6-management:</span> Checkbox to select if the device is going to use its own tools to manage IPv6 transport layer messages;  
<span style="text-decoration: underline;">Force link:</span> Specifies whether IP address, route, and gateway are assigned to the interface regardless of the link being active or only after the link has become active; when active, carrier sense events do not invoke hotplug handlers;  
<span style="text-decoration: underline;">IPv6 support:</span> User can select if IPv6 support is handled automatically, manually or disabled altogether;  
<span style="text-decoration: underline;">Modem init timeout:</span> Maximum amount of seconds before the device gives up on finishing initialization;  
<span style="text-decoration: underline;">Use default gateway:</span> Uses the default gateway obtained through DHCP. If left unchecked, no default route is configured;  
<span style="text-decoration: underline;">Prefer PPP connection:</span> If ,the modem, supports PPP and any other communication protocol (e.g. QMI, RNDIS and etc.), prioritize PPP type connection;  
<span style="text-decoration: underline;">Use gateway metric</span>: The WAN configuration by default generates a routing table entry. In this field you can alter the metric of that entry. Higher metric means higher priority;  
<span style="text-decoration: underline;">Use DNS servers advertised by peer</span>: Uses DNS servers obtained from DHCP. If left unchecked, the advertised DNS server addresses are ignored;  
<span style="text-decoration: underline;">LCP echo failure threshold:</span> LCP (link control protocol) is a part of PPP (Point-to-Point Protocol) and helps to determine the quality of data transmission. If enough failures happen, LCP presumes link to be dead. 0 disables failure count checking;  
<span style="text-decoration: underline;">LCP echo interval:</span> Determines the period of LCP echo requests. Only effective if LCP echo failure threshold is more than zero;  
<span style="text-decoration: underline;">Inactivity timeout:</span> Station inactivity limit in seconds: if a station does not send anything, the connection will be dropped. A value of 0 can be used to persist connection.  
<span style="text-decoration: underline;">Override MTU:</span> Set custom MTU to GSM interface.

<p class="callout info">Note: If modem uses QMI connection protocol and user haven’t defined custom MTU setting, the MTU on interface will be set to operator’s defined MTU value.</p>

[![image-1601982419586.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601982419586.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601982419586.png)

GSM configuration ends with firewall settings. A user can assign an already defined firewall zone or create a new one.

### Wireless

The wireless network interface parameters and configuration are described in this section.

[![image-1601982558981.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601982558981.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601982558981.png)

Configured interfaces for the physical radio device.  
<span style="text-decoration: underline;">Channel:</span> Specifies the wireless channel to use.  
<span style="text-decoration: underline;">Bitrate:</span> Specifies transfer rate in Mbit/s.  
<span style="text-decoration: underline;">SSID:</span> The broadcasted service set identifier of the wireless network.  
<span style="text-decoration: underline;">Mode:</span> Selects the operation mode of the wireless network interface controller.  
<span style="text-decoration: underline;">BSSID:</span> The basic service set identification of the network, only applicable in adhoc or STA mode.  
<span style="text-decoration: underline;">Encryption:</span> Wireless encryption method.

[![image-1601982595431.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601982595431.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601982595431.png)

List of associated wireless stations.  
The Device Configuration section covers physical settings of the radio hardware such as channel, transmit power or antenna selection which are shared among all defined wireless networks (if the radio hardware is multi-SSID capable). Per network settings like encryption or operation mode are grouped in the Interface Configuration.

[![image-1601982626129.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601982626129.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601982626129.png)

General device settings.

[![image-1689164526938.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164526938.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164526938.png)

Advanced device settings.

[![image-1689164604885.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164604885.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164604885.png)

General interface settings.

[![image-1689164644127.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164644127.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164644127.png)

Wireless security interface settings.

[![image-1689164733815.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164733815.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164733815.png)

MAC-Filter settings.

[![image-1689164771647.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164771647.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164771647.png)

Advanced interface settings.

### DHCP and DNS

DHCP server and DNS forward for NAT firewalls is described in this section.

[![image-1689164834063.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164834063.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164834063.png)

General DHCP settings.

[![image-1689164924689.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164924689.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164924689.png)

Resolve and hosts files settings.

[![image-1689164959749.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164959749.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164959749.png)

TFTP server settings.

[![image-1689164984452.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689164984452.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689164984452.png)

Advanced settings.

[![image-1601982769138.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601982769138.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601982769138.png)

List of active DHCP and static leases. It is also possible to assign fixed IP addresses to hosts on the network, based on their MAC (hardware) address.

### Hostnames

[![image-1601983068649.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601983068649.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601983068649.png)

List of existing host names. Addition or deletion is allowed for the user.

### Static routes

Routes specify over which interface and gateway a certain host or network can be reached.

[![image-1601983099686.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601983099686.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601983099686.png)

Current IPv4 and IPv6 static routes configuration.  
<span style="text-decoration: underline;">Interface:</span> Lets to chose for which interface static route is created.  
<span style="text-decoration: underline;">Target:</span> Defines target host IP or network.  
<span style="text-decoration: underline;">IPv4 Netmask:</span> Defines netmask if the target is a network.  
<span style="text-decoration: underline;">IPv4/IPv6 Gateway:</span> Defines IPv4 or IPv6 gateway.  
<span style="text-decoration: underline;">Metric:</span> Specifies the route metric to use for the route.  
<span style="text-decoration: underline;">MTU</span>: Maximum Transmit/Receive Unit, in bytes.  
<span style="text-decoration: underline;">Route type:</span> All incoming packets can be: accepted, rejected, dropped.

### Diagnostics

[![image-1601983517039.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601983517039.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601983517039.png)

Diagnostics tools which can be used to diagnose some of the networking problems: ping, traceroute and nslookup.

### Firewall

This subsection is divided into four categories: general settings, port forwards, traffic rules and custom rules.

#### General settings

[![image-1689165180227.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689165180227.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689165180227.png)

General Settings for firewall can be changed in General Settings screen. These settings are defined as follows:  
<span style="text-decoration: underline;">Input:</span> All incoming packets can be: accepted, rejected, dropped.  
<span style="text-decoration: underline;">Output:</span> All outgoing packets can be: accepted, rejected, dropped.  
<span style="text-decoration: underline;">Forward:</span> All packets being sent to another device can be: accepted, rejected, dropped.

[![image-1601983200596.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601983200596.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601983200596.png)

Additional zones for firewall can be created, edited or deleted.  
<span style="text-decoration: underline;">Zone =&gt; Forwardings:</span> Defines zones and their traffic flow.  
<span style="text-decoration: underline;">Input</span>: All incoming packets can be: accepted, rejected, dropped.  
<span style="text-decoration: underline;">Output:</span> All outgoing packets can be: accepted, rejected, dropped.  
<span style="text-decoration: underline;">Forward:</span> All packets being sent to another device can be: accepted, rejected, dropped.  
<span style="text-decoration: underline;">Masquerading:</span> Allows one or more devices in a zones network without assigned IP addresses to communicate with the Internet.  
<span style="text-decoration: underline;">MSS clamping:</span> Change the maximum segment size (MSS) of all TCP connections passing through this zone with MTU lower than the Ethernet default of 1500.

<p class="callout info">Additional actions can be performed with zones: add, edit, delete.</p>

[![image-1689165259861.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689165259861.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689165259861.png)

Common properties of newly created or edited zones can be edited in this panel. The input and output options set the default policies for traffic entering and leaving this zone while the forward option describes the policy for forwarded traffic between different networks within the zone. Covered networks specify which available networks are members of this zone.

[![image-1689165330491.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689165330491.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689165330491.png)

Advanced settings of new created or edited zone. Restrict to address family option defines to what IP families the zone belongs to IPv4, IPv6 or both. Restrict masquerading to given source/destination subnets defines one or more subnets for which the masquerading option is applied to. Connection tracking and logging options enable additional information gathering on the zone.

[![image-1689165393653.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689165393653.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689165393653.png)

Controls of the forwarding policies between new/edited zone and other zones. Destination zones cover forwarded traffic originating from the new/edited zone. Source zones match forwarded traffic from other zones targeted at the new/edited zone. The forwarding rule is unidirectional, e.g. a forward from LAN to WAN does not imply a permission to forward from WAN to LAN as well.

#### Port forwards

[![image-1601983338573.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601983338573.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601983338573.png)

Port forwarding allows remote computers on the Internet to connect to a specific computer or service within the private LAN. It is done in a way of routing network packets within a private network created by the device. Settings for the port forwarding of the device are defined as follows:  
<span style="text-decoration: underline;">Name:</span> The name of the port forwarding rule.  
<span style="text-decoration: underline;">Match:</span> Informs what port forward is matched to.  
<span style="text-decoration: underline;">Forward to:</span> Informs where the port is forwarded to.  
<span style="text-decoration: underline;">Enable:</span> Enable (checked) or disable port forward.  
<span style="text-decoration: underline;">Sort:</span> Allows to sort port forwarding.  
The user can add, edit or delete port forwarding rules.

#### Traffic rules

[![image-1601983387128.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601983387128.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601983387128.png)

Traffic rules which define policies for packets traveling between different zones.  
<span style="text-decoration: underline;">Name:</span> The name of the traffic rule.  
<span style="text-decoration: underline;">Match:</span> Informs what ICMP types are matched.  
<span style="text-decoration: underline;">Action:</span> Informs what action would be performed.  
<span style="text-decoration: underline;">Enable:</span> Enable (checked) or disable the rule.  
<span style="text-decoration: underline;">Sort:</span> Allows to sort rules.

The user can add, edit or delete traffic rules. For every rule can be defined these options: name,restrict to address family, protocol, match ICMP type, source and destination zones, source MAC, IP addresses and port, destination IP address and port, action and extra arguments, month and weekdays for which rule will apply, start/stop dates and times, time in UTC.

[![image-1601983450903.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601983450903.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601983450903.png)

Source NAT, which is a specific form of masquerading which allows fine grained control over the source IP used for outgoing traffic, for the example to map multiple WAN addresses to internal subnets.  
The user can add, edit or delete source NAT rules. For every rule can be defined these options: name, protocol, source and destination zones, source, destination, SNAT IP addresses, ports, extra arguments, month and weekdays for which rule will apply, start/stop dates and times, time in UTC.

#### Custom rules

[![image-1601983486025.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601983486025.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601983486025.png)

Custom rules allow to executing arbitrary iptables commands which are not otherwise covered by the firewall framework. The commands are executed after each firewall restart, right after the default ruleset has been loaded.

### GSM

<p class="callout info">Note: If you have a WCC Lite without a modem, the GSM tab will still be visible, but these changes won't affect anything.</p>

[![image-1689165599853.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689165599853.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689165599853.png)

#### SIM cards parameters

Parameters for SIM card. If single SIM modem is used, there won’t be ”SIM 1” and ”SIM 2” tabs.  
<span style="text-decoration: underline;">Enable:</span> Enable or disable this SIM card.  
<span style="text-decoration: underline;">PIN code:</span> PIN code to use on that SIM card.  
<span style="text-decoration: underline;">APN:</span> APN to use on that SIM car.  
<span style="text-decoration: underline;">PAP/CHAP username:</span> Username (optional).  
<span style="text-decoration: underline;">PAP/CHAP password:</span> Password (optional).

#### Modem parameters

Enable data connection: Enable or disable data connection through GSM modem.  
<span style="text-decoration: underline;">Priority SIM:</span> Primary SIM card (if Dual SIM modem is used). Mainly used for pinger configuration.  
<span style="text-decoration: underline;">Service Type:</span> Which radio access technology will be used when connecting to the gsm network.

#### Pinger configuration

Pinger is a service which pings defined hosts to check internet connection. If both of these hosts are unreachable pinger will wait and restart modem (or switch SIM card, if Dual-SIM modem is installed in WCC Lite)  
<span style="text-decoration: underline;">Disable:</span> Disable pinger functionality.  
<span style="text-decoration: underline;">Failed ping count</span>: Limit of failed ping requests, before pinger decides that internet connection is lost.  
<span style="text-decoration: underline;">Reset modem:</span> If checked, pinger resets gsm modem after ”Failed ping count”.  
<span style="text-decoration: underline;">Switch SIM:</span> If checked, pinger switches SIM to non-priority after ”Priority SIM retry count”. If internet connection is not available with non-priority SIM as well, pinger switches back to priority SIM after one failed ping attempt.  
<span style="text-decoration: underline;">Priority SIM retry count:</span> How many blocks of failed pings will the pinger tolerate, before switching to non-priority SIM.  
<span style="text-decoration: underline;">Ping interval (minutes):</span> Interval between ping requests.  
<span style="text-decoration: underline;">Primary host:</span> The host that will be pinged first.  
<span style="text-decoration: underline;">Secondary host:</span> The host that will be pinged second, if the primary host fails.  
<span style="text-decoration: underline;">Network interface</span>: GSM network interface name.

<p class="callout info">GSM Pinger is used to detect the status of network connection via cellular network. This status is written to file (/var/run/board/internet-status) and can be configured to be sent to SCADAs. If pinger is disabled, status is always set equal to zero and should not be trusted to represent internet status. Additionally, this status is reflected in the ”Status”-&gt;”GSM Status” window.</p>

This is Pinger functionality described step by step:  
• Pinger will ping the primary host every 2 minutes.  
• If the primary host fails, pinger redirects to the secondary host immediately.  
• If either primary or secondary host is responding to ping requests, pinger will continue testing connection every ”Ping interval (minutes)” parameter and no further action is taken.  
• If both primary and secondary hosts are unreachable, pinger will start pinging these hosts every ”Ping interval (minutes) / 2” minute for ”Failed ping count” times.  
• If hosts are still unreachable, pinger will try to switch SIM and restart modem (if corresponding parameters are set) or will restart immediately if single SIM modem is used.  
• SIM card is switched to non-priority SIM after ”Priority SIM retry count” failed modem restarts with priority SIM. If a non-priority SIM fails, it is switched to priority SIM in the next pinger action.

#### Dual SIM start procedure

Table below shows, which card is expected on boot, when selectiom is made between Enable/Disable SIM cards and Primary card.

<table border="1" id="bkmrk-sim-1-enabled-sim-2-" style="border-collapse: collapse; width: 100%; height: 261px;"><tbody><tr style="height: 29px;"><td style="width: 25%; height: 29px;">SIM 1 Enabled</td><td style="width: 25%; height: 29px;">SIM 2 Enabled</td><td style="width: 25%; height: 29px;">Priority SIM</td><td style="width: 25%; height: 29px;">SIM on boot</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">X</td><td style="width: 25%; height: 29px;">  
</td><td style="width: 25%; height: 29px;">1</td><td style="width: 25%; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">X</td><td style="width: 25%; height: 29px;">  
</td><td style="width: 25%; height: 29px;">2</td><td style="width: 25%; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">  
</td><td style="width: 25%; height: 29px;">X</td><td style="width: 25%; height: 29px;">1</td><td style="width: 25%; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">  
</td><td style="width: 25%; height: 29px;">X</td><td style="width: 25%; height: 29px;">2</td><td style="width: 25%; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">X</td><td style="width: 25%; height: 29px;">X</td><td style="width: 25%; height: 29px;">1</td><td style="width: 25%; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">X</td><td style="width: 25%; height: 29px;">X</td><td style="width: 25%; height: 29px;">2</td><td style="width: 25%; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">  
</td><td style="width: 25%; height: 29px;">  
</td><td style="width: 25%; height: 29px;">1</td><td style="width: 25%; height: 29px;">Undefined</td></tr><tr style="height: 29px;"><td style="width: 25%; height: 29px;">  
</td><td style="width: 25%; height: 29px;">  
</td><td style="width: 25%; height: 29px;">2</td><td style="width: 25%; height: 29px;">Undefined</td></tr></tbody></table>

### Layer 2 Tunneling Protocol

In computer networking, Layer 2 Tunneling Protocol (L2TP) is a tunneling protocol used to support virtual private networks (VPNs) or as part of the delivery of services by ISPs. It does not provide any encryption or confidentiality by itself. Rather, it relies on an encryption protocol that it passes within the tunnel to provide privacy.

#### Description

The entire L2TP packet, including payload and L2TP header, is sent within a User Datagram Protocol (UDP) datagram. It is common to carry PPP sessions within an L2TP tunnel. L2TP does not provide confidentiality or strong authentication by itself. IPsec is often used to secure L2TP packets by providing confidentiality, authentication and integrity. The combination of these two protocols is generally known as L2TP/IPsec (discussed below). The two endpoints of an L2TP tunnel are called the LAC (L2TP Access Concentrator) and the LNS (L2TP Network Server). The LNS waits for new tunnels. Once a tunnel is established, the network traffic between the peers is bidirectional. To be useful for networking, higher-level protocols are then run through the L2TP tunnel. To facilitate this, an L2TP session (or ’call’) is established within the tunnel for each higher-level protocol such as PPP. Either the LAC or LNS may initiate sessions. The traffic for each session is isolated by L2TP, so it is possible to set up multiple virtual networks across a single tunnel. MTU should be considered when implementing L2TP. The packets exchanged within an L2TP tunnel are categorized as either control packets or data packets. L2TP provides reliability features for the control packets, but no reliability for data packets. Reliability, if desired, must be provided by the nested protocols running within each session of the L2TP tunnel. L2TP allows the creation of a virtual private dialup network (VPDN) to connect a remote client to its corporate network by using a shared infrastructure, which could be the Internet or a service provider’s network.

#### Setting up L2TP interface

In order to create a L2TP tunnel following steps are required:

1\. Go to **Network &gt; Interfaces &gt; Add new interface:**

[![image-1689167492396.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689167492396.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689167492396.png)

2\. Enter interface name and select L2TP protocol:

[![image-1689167536625.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689167536625.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689167536625.png)

3\. Enter server name and authorization parameters:

[![image-1601984049181.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601984049181.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601984049181.png)

4\. Save and apply the new configuration. A new network interface will appear.

# 8.8 Users

#### Edit groups

[![image-1689228768652.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689228768652.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689228768652.png)

On this page user groups can be edited, deleted or added.   
<span style="text-decoration: underline;">Groups:</span> name of the user group  
<span style="text-decoration: underline;">Status:</span> shows authorization level set to specific user group. The higher the lever, the higher authorization requirements.  
<span style="text-decoration: underline;">Actions:</span> edit or delete user group

##### Add new group

[![image-1689230250950.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689230250950.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689230250950.png)

Configuration window for new group. After group name is determined, acc ess level and permissions can be set.

#### Edit users

[![image-1689230967641.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689230967641.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689230967641.png)

On edit users window list of all the users is shown.  
<span style="text-decoration: underline;">Users:</span> user name  
<span style="text-decoration: underline;">Status:</span> shows if SSH access is enabled and which group the user belongs to.  
<span style="text-decoration: underline;">Actions:</span> edit, delete or change password for the user

##### Add new user[![image-1689231760999.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689231760999.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689231760999.png)

Configuration window for new user. To create a new user, name and password should be created and user group and SSH access should be set.

#### Password

[![image-1689232974821.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689232974821.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689232974821.png)

Changes password of the device.

# 8.9 Logout

[![image-1689167799567.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689167799567.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689167799567.png)

To log out of the device graphical user interface a logout button in the interface’s upper right corner should be pressed. A user is automatically disconnected after ten minutes of inactivity. This ensures that the device would not be suspect to any deliberate damage made by unauthorized access.

# 9 API

The firmware of the WCC Lite features a built-­in API which is accessible via the web interface. As of version 1.2.11, it does not implement any access restriction features apart from those provided by the firewall functionality.

Individual API endpoints can be enabled or disabled via the web configuration interface at Services­&gt;API.

All endpoints are disabled by default. Available API endpoints are shown in the table below.

<table border="1" id="bkmrk-path-description-%2Fap" style="border-collapse: collapse; width: 106.173%; height: 567.031px;"><tbody><tr style="height: 80.0994px;"><td style="width: 18.6629%; height: 80.0994px;">Path</td><td style="width: 27.3146%; height: 80.0994px;">Description</td><td style="width: 20.148%; height: 80.0994px;">Request body

(encoded as "multipart-form-data")

</td><td style="width: 33.8632%; height: 80.0994px;">Response body example

(json format)

</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/version</td><td style="width: 27.3146%; height: 29.7017px;">Version of the API</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">{  
 "api\_version": "2",  
 "api\_patch": "1",  
 "sync\_version": "lite1"  
}</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/actions </td><td style="width: 27.3146%; height: 29.7017px;">List of available points</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/syncVersion</td><td style="width: 27.3146%; height: 29.7017px;">Version of the sync service</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 80.0994px;"><td style="width: 18.6629%; height: 80.0994px;">/api/sync</td><td style="width: 27.3146%; height: 80.0994px;">Protocol hub configuration upload  
(key name="file").

Returns excel-utility output )\*

</td><td style="width: 20.148%; height: 80.0994px;"><div><span class="legacy-color-text-default">{</span></div><div><span class="legacy-color-text-default"> </span><span data-colorid="ko1fxaolvq">"file"</span><span class="legacy-color-text-default">: </span><span data-colorid="pjmlwkiiid">"config.xlsx"</span></div><div><span class="legacy-color-text-default">}</span></div></td><td style="width: 33.8632%; height: 80.0994px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/syslog </td><td style="width: 27.3146%; height: 29.7017px;">Prints out the syslog</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/systemInfo</td><td style="width: 27.3146%; height: 29.7017px;">General system info</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/gsmInfo </td><td style="width: 27.3146%; height: 29.7017px;">GSM modem information</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/devices </td><td style="width: 27.3146%; height: 29.7017px;">List of configured devices</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 46.5057px;"><td style="width: 18.6629%; height: 46.5057px;">/api/device/info </td><td style="width: 27.3146%; height: 46.5057px;">Returns configured devices information.  
(key name="device\_alias")\*\*</td><td style="width: 20.148%; height: 46.5057px;"><div><span class="legacy-color-text-default">{</span></div><div><span class="legacy-color-text-default"> </span><span data-colorid="tecnjgtiur">"device\_alias"</span><span class="legacy-color-text-default">: </span><span data-colorid="zqp7m8lka7">"INV1"</span></div><div><span class="legacy-color-text-default">}</span></div></td><td style="width: 33.8632%; height: 46.5057px;">{  
 "devices": \[  
 {  
 "device\_alias": "INV1",  
 "name": "INV1",  
 "protocol": "modbus rtu"  
 }  
 \]  
}</td></tr><tr style="height: 46.5057px;"><td style="width: 18.6629%; height: 46.5057px;">/api/device/tags</td><td style="width: 27.3146%; height: 46.5057px;">List of tags of a particular configured device.

(key name="device\_alias")\*\*

</td><td style="width: 20.148%; height: 46.5057px;"><div>{  
 "device_alias": "INV1"  
}</div></td><td style="width: 33.8632%; height: 46.5057px;">{  
 "total\_signals": "7",  
 "signals": \[  
 {  
 "signal\_name": "Active power",  
 "source\_device\_alias": "",  
 "input\_topic": "tag/INV1/P/rin",  
 "output\_topic": "tag/INV1/P/out",  
 "signal\_alias": "P"  
 },

...

</td></tr><tr style="height: 46.5057px;"><td style="width: 18.6629%; height: 46.5057px;">/api/device/tag/value</td><td style="width: 27.3146%; height: 46.5057px;">Returns tags value, name, timestamp, and flags of a particular device.   
(key name="device\_alias",

key name="signal\_alias")\*\*

</td><td style="width: 20.148%; height: 46.5057px;">{  
 "device\_alias": "INV1",  
 "signal\_alias": "P"  
}</td><td style="width: 33.8632%; height: 46.5057px;">{  
 "total\_signals": "1",  
 "signal\_values": \[  
 {  
 "signal\_name": "Active power",  
 "value": "5.9589999999999996",  
 "timestamp": "1708000203824",  
 "flags": ""  
 }  
 \]  
}</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/tags </td><td style="width: 27.3146%; height: 29.7017px;">List of configured tags</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/sysupgrade </td><td style="width: 27.3146%; height: 29.7017px;">Firmware upgrade. (key name="file")\*</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr></tbody></table>

\* Endpoints accepting files (requires WCC Lite Firmware version 1.8 or newer)  
\*\* Endpoints accepting field data (requires WCC Lite firmware version 1.8 or newer)

The API accepts data and files as POST requests encoded as ”multipart/form­data”.# 10 SNMP

SNMP (Simple Network Management Protocol) is an internet­ standard protocol for managing devices on IP networks. SNMP exposes management data in the form of a hierarchy of variables in a MIB (Management Information Base).

WCC Lite supports SNMP service which is not added to default build of firmware but can be installed as a module. It enables user to collect data on various parameters of system:

- CPU time ­ time spent for calculations of various processes: 
    - *user* ­- time for user processes;
    - *system* -­ time for system processes;
    - *idle* ­- time spent idling;
    - *interrupts* -­ time spent handling interrupts.
- *CPU load average* -­ CPU load average for 1, 5 and 15 minutes respectively;
- Disk usage: 
    - *total* ­- total amount of storage in the device (in kB)
    - *available* -­ amount of storage available to store data (in kB)
    - *used* -­ amount of storage used in the device (in KB)
    - *blocks used percentage* ­- blocks (sectors) used to store data in a disk (in kB)
    - *inodes used percentage* ­- the inode (index node) is a data structure in a Unix­ style file system that describes a file­system object such as a file or a directory. Each inode stores the attributes and disk block location(s) of the object’s data.
- *Memory usage* ­- RAM usage statistics: 
    - *total* ­- total amount of RAM in the device (in kB);
    - *available* -­ unused amount of RAM in the device (in kB);
    - *shared* -­ shared amount of RAM between multiple processes (in kB);
    - *buffered* - refers to an electronic buffer placed between the memory and the memory controller;
    - *cached* ­- a portion of memory made of high­ speed static RAM (SRAM) instead of the slower dynamic RAM (DRAM) used for main memory;
- *Network interfaces*: 
    - *MTU* ­- maximum transmission unit to be sent over network;
    - *speed* -­ rate of network transmission;
    - *physical address* ­- unique MAC address assigned to a device;
    - *tx/rx*: byte, packet, drop, error count;
- *System properties*: 
    - *uptime* -­ time since the device was turned on;
    - *process uptime* ­- time since the process has been started;
    - *hostname* ­- a label that is assigned to a device connected to a computer network;
    - *name* ­- name of the device (if defined);
    - *location* ­- location of the device (if defined).# 11 SMS sender

### General

SMS sender is a service that lets user configure WCC Lite to send SMS on a set tag triggers.

<p class="callout success">SMS sender functionality is available since firmware version v1.5.4, of WCC Lite.</p>

### Configuring SMS sender

To configure WCC Lite to use SMS sender user must fill in the needed parameters in Excel configuration. These parameters are shown in the tables below.

*SMS sender parameters for Devices tab:*

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 228px;"><tbody><tr style="height: 44px;"><td class="align-center" rowspan="2" style="width: 16.4814%; height: 54px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="width: 9.07411%; height: 54px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="width: 25.8644%; height: 54px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="width: 10.2777%; height: 54px;">**Required  
</td><td class="align-center" rowspan="2" style="width: 18.9044%; height: 54px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 44px; width: 19.3827%;">**Range**

</td></tr><tr style="height: 10px;"><td class="align-center" style="height: 10px; width: 9.62963%;">Min

</td><td class="align-center" style="width: 9.75309%; height: 10px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">name</td><td style="width: 9.07411%; height: 29px;">string</td><td style="width: 25.8644%; height: 29px;">User-friendly device name</td><td style="width: 10.2777%; height: 29px;">Yes</td><td style="width: 18.9044%; height: 29px;">  
</td><td style="width: 9.62963%; height: 29px;">  
</td><td style="width: 9.75309%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">description</td><td style="width: 9.07411%; height: 29px;">string</td><td style="width: 25.8644%; height: 29px;">Description of the device</td><td style="width: 10.2777%; height: 29px;">No</td><td style="width: 18.9044%; height: 29px;">  
</td><td style="width: 9.62963%; height: 29px;">  
</td><td style="width: 9.75309%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">device\_alias</td><td style="width: 9.07411%; height: 29px;">string</td><td style="width: 25.8644%; height: 29px;">Device alias to be used in configuration</td><td style="width: 10.2777%; height: 29px;">Yes</td><td style="width: 18.9044%; height: 29px;">  
</td><td style="width: 9.62963%; height: 29px;">  
</td><td style="width: 9.75309%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">enable</td><td style="width: 9.07411%; height: 29px;">boolean</td><td style="width: 25.8644%; height: 29px;">Enabling/disabling of a device</td><td style="width: 10.2777%; height: 29px;">No</td><td style="width: 18.9044%; height: 29px;">1</td><td style="width: 9.62963%; height: 29px;">0</td><td style="width: 9.75309%; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">protocol</td><td style="width: 9.07411%; height: 29px;">string</td><td style="width: 25.8644%; height: 29px;">Selection of protocol</td><td style="width: 10.2777%; height: 29px;">Yes</td><td style="width: 18.9044%; height: 29px;">  
</td><td colspan="2" style="width: 9.62963%; height: 29px;">**SMS sender**</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">host</td><td style="width: 9.07411%; height: 29px;"><div><div>array</div></div></td><td style="width: 25.8644%; height: 29px;">List of phone numbers to send SMS to, separated by space.</td><td style="width: 10.2777%; height: 29px;">Yes</td><td style="width: 18.9044%; height: 29px;">  
</td><td style="width: 9.62963%; height: 29px;">  
</td><td style="width: 9.75309%; height: 29px;">  
</td></tr></tbody></table>

[![image-1632837719431.png](https://wiki.elseta.com/uploads/images/gallery/2021-09/scaled-1680-/image-1632837719431.png)](https://wiki.elseta.com/uploads/images/gallery/2021-09/image-1632837719431.png)

*SMS sender parameters for Signals tab:*

<table border="1" id="bkmrk-parameter-type-descr-0" style="border-collapse: collapse; width: 100%; height: 455px;"><tbody><tr style="height: 44px;"><td class="align-center" rowspan="2" style="width: 17.0987%; height: 54px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="width: 8.45683%; height: 54px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="width: 32.0373%; height: 54px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="width: 16.5739%; height: 54px;">**Required  
</td><td class="align-center" rowspan="2" style="width: 10.1389%; height: 54px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 44px; width: 15.8025%;">**Range**

</td></tr><tr style="height: 10px;"><td class="align-center" style="height: 10px; width: 14.5679%;">Min

</td><td class="align-center" style="width: 1.23457%; height: 10px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 29px;">signal\_name</td><td style="width: 8.45683%; height: 29px;">string</td><td style="width: 32.0373%; height: 29px;">User-friendly signal name</td><td style="width: 16.5739%; height: 29px;">Yes</td><td style="width: 10.1389%; height: 29px;"></td><td style="width: 14.5679%; height: 29px;">  
</td><td style="width: 1.23457%; height: 29px;"></td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 29px;">device\_alias</td><td style="width: 8.45683%; height: 29px;">string</td><td style="width: 32.0373%; height: 29px;">Device alias from a Devices tab</td><td style="width: 16.5739%; height: 29px;">Yes</td><td style="width: 10.1389%; height: 29px;">  
</td><td style="width: 14.5679%; height: 29px;">  
</td><td style="width: 1.23457%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 29px;">signal\_alias</td><td style="width: 8.45683%; height: 29px;">string</td><td style="width: 32.0373%; height: 29px;">Unique signal name to be used</td><td style="width: 16.5739%; height: 29px;">Yes</td><td style="width: 10.1389%; height: 29px;">  
</td><td style="width: 14.5679%; height: 29px;">  
</td><td style="width: 1.23457%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 29px;">source\_device\_alias</td><td style="width: 8.45683%; height: 29px;">string</td><td style="width: 32.0373%; height: 29px;">device\_alias of the source device</td><td style="width: 16.5739%; height: 29px;">No</td><td style="width: 10.1389%; height: 29px;">  
</td><td style="width: 14.5679%; height: 29px;">  
</td><td style="width: 1.23457%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 29px;">source\_signal\_alias</td><td style="width: 8.45683%; height: 29px;">string</td><td style="width: 32.0373%; height: 29px;">source\_alias of the source signal</td><td style="width: 16.5739%; height: 29px;">No</td><td style="width: 10.1389%; height: 29px;">  
</td><td style="width: 14.5679%; height: 29px;">  
</td><td style="width: 1.23457%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 29px;">enable</td><td style="width: 8.45683%; height: 29px;">boolean</td><td style="width: 32.0373%; height: 29px;">Enabling/disabling of a signal</td><td style="width: 16.5739%; height: 29px;">No</td><td style="width: 10.1389%; height: 29px;">1</td><td style="width: 14.5679%; height: 29px;">0</td><td style="width: 1.23457%; height: 29px;">1</td></tr><tr><td style="width: 17.0987%;">log </td><td style="width: 8.45683%;">integer</td><td style="width: 32.0373%;">Enable logging in event log </td><td style="width: 16.5739%;">No</td><td style="width: 10.1389%;">0</td><td style="width: 14.5679%;">0</td><td style="width: 1.23457%;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 29px;">job\_todo</td><td style="width: 8.45683%; height: 29px;">string</td><td style="width: 32.0373%; height: 29px;">Specific SMS sender tag type</td><td style="width: 16.5739%; height: 29px;">Yes</td><td style="width: 10.1389%; height: 29px;">  
</td><td colspan="2" style="width: 15.8025%; height: 29px;">send-sms, device-control, device-status</td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 61px;">tag\_job\_todo</td><td style="width: 8.45683%; height: 61px;">string</td><td style="width: 32.0373%; height: 61px;">SMS sender tag for **send-sms**:

*text message*

</td><td style="width: 16.5739%; height: 61px;">Yes</td><td style="width: 10.1389%; height: 61px;">  
</td><td colspan="2" style="width: 15.8025%; height: 61px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.0987%; height: 29px;">trigger</td><td style="width: 8.45683%; height: 29px;">string</td><td style="width: 32.0373%; height: 29px;">Trigger expression for the SMS to be sent</td><td style="width: 16.5739%; height: 29px;">No (Only for send\_sms)</td><td style="width: 10.1389%; height: 29px;">value!=0</td><td style="width: 14.5679%; height: 29px;">  
</td><td style="width: 1.23457%; height: 29px;">  
</td></tr></tbody></table>

To configure SMS sender, 3 types of signals are mandatory. These values should be written inside the *job\_todo* field for each signal:

- **send-sms** - This signal takes value from the provided *source\_signal\_alias* field and checks if the value evaluates as true against the *trigger* field. If its true, the SMS sender will send the text from the *tag\_job\_todo* field to the specified phone numbers.
- **device-control** - This signal controls if the SMS sender is enabled or disabled. Its *tag\_job\_todo* parameter should be set to enable. It takes value from the *source\_signal\_alias* field and evaluates it against the *trigger* field. If the *trigger* is evaluated as true, the SMS sender will be enabled, otherwise it will disable the SMS sender.
- **device-status** - This signal indicates if the service is enabled or not. Its *tag\_job\_todo* parameter should be set to *enabled.*

Trigger expressions can be configured with basic comparison operators:

- Less than **&lt;**
- Greater than **&gt;**
- Less than or equal to **&lt;=**
- Greater than or equal to **&gt;=**
- Equal **==**
- Not equal **!=**

*Example configuration of SMS sender (Signals tab):*

[![image-1689241823615.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689241823615.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689241823615.png)

Configuration --&gt; [Download](https://wiki.elseta.com/attachments/109)

<p class="callout info">Note: SMS Sender can only send messages that contain less than 160 characters.</p># 12 DNP 3.0



# 12.1 Introduction

DNP3 (Distributed Network Protocol) is a set of communications protocols used between components in process automation systems. Its main use is in utilities such as electric and water companies. It was developed for communications between various types of data acquisition and control equipment. It plays a crucial role in SCADA systems, where it is used by SCADA Master Stations (a.k.a. Control Centers), Remote Terminal Units (RTUs), and Intelligent Electronic Devices (IEDs). It is primarily used for communications between a master station and RTUs or IEDs. ICCP, the Inter­Control Center Communications Protocol (a part of IEC-60870­6), is used for inter­master station communications.

Elseta’s DNP3 stack has both Master and Slave protocols implemented. Both of them are able to serve multiple serial (over physical RS­485 line), TCP or TLS (over TCP) connections with high efficiency.

IEEE­1815 defines 4 subset levels (1­4) that consist of the objects and function codes that must be supported by the master and outstation. Levels 1­3 are supported fully and level 4 is supported partially. To get more information about how DNP3 works and what capabilities are supported one should get a copy of protocol specification and/or check Slave Interoperability List/Configuration guides for both Master and Slave protocols.

<p class="callout info">To set up TLS connection for both DNP3 Master and Slave, refer to sections Excel configuration and Certificates. All keys and certificates should be provided in the PEM format.</p>

<p class="callout success">If no configuration is set up, DNP3 Master and Slave services are not started.</p>

# 12.2 DNP 3.0 Master

Default group and variation sets are used to send commands. If slave devices support different groups and variations, they can be adjusted in Excel configuration. For more information check section [Excel configuration](https://wiki.elseta.com/books/manual/chapter/18-excel-configuration).

#### Configuring datapoints

To use DNP3 Master in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in ­Devices and Signals.

##### DNP3 Master parameters for Devices tab

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 2810.58px;"><tbody><tr style="height: 80.1562px;"><th rowspan="2" style="width: 20.3956%; height: 137.937px;">**Parameter**  
  
</th><th rowspan="2" style="width: 8.40544%; height: 137.937px;">**Type**  
  
</th><th rowspan="2" style="width: 24.5983%; height: 137.937px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 12.6082%; height: 80.1562px;">**Required**  
  
</th><th rowspan="2" style="width: 16.8109%; height: 137.937px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 17.1817%; height: 80.1562px;">**Range**  
  
</th></tr><tr style="height: 57.7812px;"><th class="align-center" style="width: 6.30408%; height: 57.7812px;">TCP/

TLS

</th><th class="align-center" style="width: 6.30408%; height: 57.7812px;">Serial</th><th class="align-center" style="width: 8.52905%; height: 57.7812px;">Min</th><th class="align-center" style="width: 8.65266%; height: 57.7812px;">Max</th></tr><tr style="height: 35.3906px;"><td style="width: 20.3956%; height: 35.3906px;">name</td><td style="width: 8.40544%; height: 35.3906px;">string </td><td style="width: 24.5983%; height: 35.3906px;">User-friendly device name</td><td style="width: 6.30408%; height: 35.3906px;">Yes</td><td style="width: 6.30408%; height: 35.3906px;">Yes</td><td style="width: 16.8109%; height: 35.3906px;"></td><td style="width: 8.52905%; height: 35.3906px;">  
</td><td style="width: 8.65266%; height: 35.3906px;"></td></tr><tr style="height: 35.3906px;"><td style="width: 20.3956%; height: 35.3906px;">description</td><td style="width: 8.40544%; height: 35.3906px;">string</td><td style="width: 24.5983%; height: 35.3906px;">Description of a device</td><td style="width: 6.30408%; height: 35.3906px;">No</td><td style="width: 6.30408%; height: 35.3906px;">No</td><td style="width: 16.8109%; height: 35.3906px;"></td><td style="width: 8.52905%; height: 35.3906px;">  
</td><td style="width: 8.65266%; height: 35.3906px;"></td></tr><tr style="height: 46.5938px;"><td style="width: 20.3956%; height: 46.5938px;">device\_alias</td><td style="width: 8.40544%; height: 46.5938px;">string</td><td style="width: 24.5983%; height: 46.5938px;">Alphanumeric string to identify a device</td><td style="width: 6.30408%; height: 46.5938px;">Yes</td><td style="width: 6.30408%; height: 46.5938px;">Yes</td><td style="width: 16.8109%; height: 46.5938px;">  
</td><td style="width: 8.52905%; height: 46.5938px;">  
</td><td style="width: 8.65266%; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 20.3956%; height: 46.5938px;">enable</td><td style="width: 8.40544%; height: 46.5938px;">boolean</td><td style="width: 24.5983%; height: 46.5938px;">Enabling/disabling of a device</td><td style="width: 6.30408%; height: 46.5938px;">No</td><td style="width: 6.30408%; height: 46.5938px;">No</td><td style="width: 16.8109%; height: 46.5938px;">1</td><td style="width: 8.52905%; height: 46.5938px;">0</td><td style="width: 8.65266%; height: 46.5938px;">1</td></tr><tr style="height: 96.7969px;"><td style="width: 20.3956%; height: 96.7969px;">protocol</td><td style="width: 8.40544%; height: 96.7969px;">string</td><td style="width: 24.5983%; height: 96.7969px;">Protocol to be used (”dnp3 serial”/”dnp3 tcp” (case insensitive))</td><td style="width: 6.30408%; height: 96.7969px;">Yes</td><td style="width: 6.30408%; height: 96.7969px;">Yes</td><td style="width: 16.8109%; height: 96.7969px;">  
</td><td colspan="2" style="width: 17.1817%; height: 96.7969px;">DNP3 TCP, DNP3 serial</td></tr><tr style="height: 113.781px;"><td style="width: 20.3956%; height: 113.781px;">mode</td><td style="width: 8.40544%; height: 113.781px;">string</td><td style="width: 24.5983%; height: 113.781px;">Choosing between TCP, TLS and SERIAL modes . If protocol provided DNP3 TCP mode defaults to tcp and if DNP3 serial is provided mode defaults to serial</td><td style="width: 6.30408%; height: 113.781px;">No</td><td style="width: 6.30408%; height: 113.781px;">No</td><td style="width: 16.8109%; height: 113.781px;">TCP (for DNP3 TCP)

SERIAL

(for DNP3 serial)

</td><td colspan="2" style="width: 17.1817%; height: 113.781px;">TCP, TLS (for DNP3 TCP)

SERIAL (for DNP3 serial)

</td></tr><tr style="height: 63.1875px;"><td style="width: 20.3956%; height: 63.1875px;">host</td><td style="width: 8.40544%; height: 63.1875px;">string</td><td style="width: 24.5983%; height: 63.1875px;">IP address of TCP slave device</td><td style="width: 6.30408%; height: 63.1875px;">Yes</td><td style="width: 6.30408%; height: 63.1875px;">-</td><td style="width: 16.8109%; height: 63.1875px;">  
</td><td style="width: 8.52905%; height: 63.1875px;">  
</td><td style="width: 8.65266%; height: 63.1875px;">  
</td></tr><tr style="height: 63.3906px;"><td style="width: 20.3956%; height: 63.3906px;">bind\_address </td><td style="width: 8.40544%; height: 63.3906px;">string</td><td style="width: 24.5983%; height: 63.3906px;">IP address of network adapter used to connect to slave device</td><td style="width: 6.30408%; height: 63.3906px;">No</td><td style="width: 6.30408%; height: 63.3906px;">No</td><td style="width: 16.8109%; height: 63.3906px;">0.0.0.0</td><td style="width: 8.52905%; height: 63.3906px;">  
</td><td style="width: 8.65266%; height: 63.3906px;">  
</td></tr><tr style="height: 63.1875px;"><td style="width: 20.3956%; height: 63.1875px;">port</td><td style="width: 8.40544%; height: 63.1875px;">integer</td><td style="width: 24.5983%; height: 63.1875px;">TCP communication port</td><td style="width: 6.30408%; height: 63.1875px;">No</td><td style="width: 6.30408%; height: 63.1875px;">No</td><td style="width: 16.8109%; height: 63.1875px;">20000</td><td style="width: 8.52905%; height: 63.1875px;">  
</td><td style="width: 8.65266%; height: 63.1875px;">  
</td></tr><tr style="height: 80px;"><td style="width: 20.3956%; height: 80px;">device</td><td style="width: 8.40544%; height: 80px;">integer</td><td style="width: 24.5983%; height: 80px;">Communication port (”PORT1” or ”PORT2”)</td><td style="width: 6.30408%; height: 80px;">-</td><td style="width: 6.30408%; height: 80px;">Yes</td><td style="width: 16.8109%; height: 80px;">  
</td><td style="width: 8.52905%; height: 80px;">  
</td><td style="width: 8.65266%; height: 80px;">  
</td></tr><tr style="height: 80px;"><td style="width: 20.3956%; height: 80px;">baudrate</td><td style="width: 8.40544%; height: 80px;">integer</td><td style="width: 24.5983%; height: 80px;">Communication speed, bauds/s</td><td style="width: 6.30408%; height: 80px;">-</td><td style="width: 6.30408%; height: 80px;">No</td><td style="width: 16.8109%; height: 80px;">9600</td><td colspan="2" style="width: 17.1817%; height: 80px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200</td></tr><tr style="height: 80px;"><td style="width: 20.3956%; height: 80px;">databits</td><td style="width: 8.40544%; height: 80px;">integer</td><td style="width: 24.5983%; height: 80px;">Data bit count for communication</td><td style="width: 6.30408%; height: 80px;">-</td><td style="width: 6.30408%; height: 80px;">No</td><td style="width: 16.8109%; height: 80px;">8</td><td style="width: 8.52905%; height: 80px;">6</td><td style="width: 8.65266%; height: 80px;">9</td></tr><tr style="height: 80px;"><td style="width: 20.3956%; height: 80px;">stopbits</td><td style="width: 8.40544%; height: 80px;">integer</td><td style="width: 24.5983%; height: 80px;">Stop bit count for communication</td><td style="width: 6.30408%; height: 80px;">-</td><td style="width: 6.30408%; height: 80px;">No</td><td style="width: 16.8109%; height: 80px;">1</td><td style="width: 8.52905%; height: 80px;">1</td><td style="width: 8.65266%; height: 80px;">2</td></tr><tr style="height: 80px;"><td style="width: 20.3956%; height: 80px;">parity</td><td style="width: 8.40544%; height: 80px;">string</td><td style="width: 24.5983%; height: 80px;">Communication parity option</td><td style="width: 6.30408%; height: 80px;">-</td><td style="width: 6.30408%; height: 80px;">No</td><td style="width: 16.8109%; height: 80px;">none</td><td colspan="2" style="width: 17.1817%; height: 80px;">none, even, odd</td></tr><tr style="height: 80px;"><td style="width: 20.3956%; height: 80px;">flowcontrol</td><td style="width: 8.40544%; height: 80px;">string</td><td style="width: 24.5983%; height: 80px;">Communication device flow control option. </td><td style="width: 6.30408%; height: 80px;">-</td><td style="width: 6.30408%; height: 80px;">No</td><td style="width: 16.8109%; height: 80px;">none</td><td colspan="2" style="height: 80px; width: 17.1817%;">none</td></tr><tr style="height: 63.3906px;"><td style="width: 20.3956%; height: 63.3906px;">tls</td><td style="width: 8.40544%; height: 63.3906px;">boolean</td><td style="width: 24.5983%; height: 63.3906px;">Enable/disable use of TLS  
  
</td><td style="width: 6.30408%; height: 63.3906px;">Yes (for  
TLS)</td><td style="width: 6.30408%; height: 63.3906px;">-</td><td style="width: 16.8109%; height: 63.3906px;">0</td><td style="height: 63.3906px; width: 8.52905%;">0</td><td style="width: 8.65266%; height: 63.3906px;">1</td></tr><tr style="height: 63.3906px;"><td style="width: 20.3956%; height: 63.3906px;">tls\_local\_certificate</td><td style="width: 8.40544%; height: 63.3906px;">string</td><td style="width: 24.5983%; height: 63.3906px;">Local certificate for TLS connection</td><td style="width: 6.30408%; height: 63.3906px;">Yes (for TLS)</td><td style="width: 6.30408%; height: 63.3906px;">-</td><td style="height: 63.3906px; width: 16.8109%;">  
</td><td style="width: 8.52905%; height: 63.3906px;">  
</td><td style="width: 8.65266%; height: 63.3906px;">  
</td></tr><tr style="height: 63.3906px;"><td style="width: 20.3956%; height: 63.3906px;">tls\_peer\_certificate</td><td style="width: 8.40544%; height: 63.3906px;">string</td><td style="width: 24.5983%; height: 63.3906px;">Certificate authority file for TLS connection</td><td style="width: 6.30408%; height: 63.3906px;">No (for  
TLS)</td><td style="width: 6.30408%; height: 63.3906px;">-</td><td style="height: 63.3906px; width: 16.8109%;">  
</td><td style="width: 8.52905%; height: 63.3906px;">  
</td><td style="width: 8.65266%; height: 63.3906px;">  
</td></tr><tr style="height: 63.3906px;"><td style="width: 20.3956%; height: 63.3906px;">tls\_private\_key</td><td style="width: 8.40544%; height: 63.3906px;">string</td><td style="width: 24.5983%; height: 63.3906px;">File consisting of private key for TLS connection</td><td style="width: 6.30408%; height: 63.3906px;">No (for  
TLS)</td><td style="width: 6.30408%; height: 63.3906px;">-</td><td style="width: 16.8109%; height: 63.3906px;">  
</td><td style="width: 8.52905%; height: 63.3906px;">  
</td><td style="width: 8.65266%; height: 63.3906px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 20.3956%; height: 46.5938px;">max\_rx\_frag\_size</td><td style="width: 8.40544%; height: 46.5938px;">integer</td><td style="width: 24.5983%; height: 46.5938px;">Maximum size of a received fragment.</td><td style="width: 6.30408%; height: 46.5938px;">No</td><td style="width: 6.30408%; height: 46.5938px;">No</td><td style="width: 16.8109%; height: 46.5938px;">2048</td><td style="width: 8.52905%; height: 46.5938px;">0</td><td style="width: 8.65266%; height: 46.5938px;">2048</td></tr><tr style="height: 46.3906px;"><td style="width: 20.3956%; height: 46.3906px;">destination\_address</td><td style="width: 8.40544%; height: 46.3906px;">integer</td><td style="width: 24.5983%; height: 46.3906px;">Address of a master station</td><td style="width: 6.30408%; height: 46.3906px;">No</td><td style="width: 6.30408%; height: 46.3906px;">No</td><td style="width: 16.8109%; height: 46.3906px;">1</td><td style="width: 8.52905%; height: 46.3906px;">0</td><td style="width: 8.65266%; height: 46.3906px;">65535</td></tr><tr style="height: 46.5938px;"><td style="width: 20.3956%; height: 46.5938px;">source\_address</td><td style="width: 8.40544%; height: 46.5938px;">integer</td><td style="width: 24.5983%; height: 46.5938px;">Address of a slave (local) station.</td><td style="width: 6.30408%; height: 46.5938px;">No</td><td style="width: 6.30408%; height: 46.5938px;">No</td><td style="width: 16.8109%; height: 46.5938px;">1</td><td style="width: 8.52905%; height: 46.5938px;">0</td><td style="width: 8.65266%; height: 46.5938px;">65535</td></tr><tr style="height: 80px;"><td style="width: 20.3956%; height: 80px;">unsol\_classes</td><td style="width: 8.40544%; height: 80px;">string</td><td style="width: 24.5983%; height: 80px;">Defines which classes will have unsolicited actions on startup. (Example: "1,3,2")</td><td style="width: 6.30408%; height: 80px;">No</td><td style="width: 6.30408%; height: 80px;">No</td><td style="width: 16.8109%; height: 80px;">no class</td><td style="width: 8.52905%; height: 80px;">1</td><td style="width: 8.65266%; height: 80px;">3</td></tr><tr><td style="width: 20.3956%;">unsol\_disable</td><td style="width: 8.40544%;">bool</td><td style="width: 24.5983%;">Disables unsolicited messages on startup. The parameter is going to be ignored if unsol\_classes parameter has any values assigned.</td><td style="width: 6.30408%;">No</td><td style="width: 6.30408%;">No</td><td style="width: 16.8109%;">0</td><td style="width: 8.52905%;">0</td><td style="width: 8.65266%;">1</td></tr><tr style="height: 348.938px;"><td style="width: 20.3956%; height: 348.938px;">groups\_scan\_mask</td><td style="width: 8.40544%; height: 348.938px;">integer</td><td style="width: 24.5983%; height: 348.938px;">Bitmask for enabling separate  
group scans with x06 qualifier (all objects). The parameter value is converted into a binary number where each bit stands for a separate group. Bits indexes and the groups that the represent:  
0 -­ Binary,  
1 ­- Double­bit Binary,  
2 ­- Binary Output Status,  
3 ­- Counter,  
4 ­- Frozen Counter,  
5 ­- Analog,  
6 ­- Analog Output Status,  
7 ­- Octet String  
  
(Example: 115 (0111 0011) will trigger data polls for signals whose types are - Binary, Double­bit Binary, Frozen Counter, Analog, Analog Output Status)</td><td style="width: 6.30408%; height: 348.938px;">No</td><td style="width: 6.30408%; height: 348.938px;">No</td><td style="width: 16.8109%; height: 348.938px;">0</td><td style="width: 8.52905%; height: 348.938px;">0</td><td style="width: 8.65266%; height: 348.938px;">255</td></tr><tr style="height: 66.3906px;"><td style="width: 20.3956%; height: 66.3906px;">groups\_scan\_interval</td><td style="width: 8.40544%; height: 66.3906px;">integer,

string

</td><td style="width: 24.5983%; height: 66.3906px;">Time between separate groups scans intervals in seconds. Set to 0 to disable.</td><td style="width: 6.30408%; height: 66.3906px;">No</td><td style="width: 6.30408%; height: 66.3906px;">No</td><td style="width: 16.8109%; height: 66.3906px;">0</td><td style="width: 8.52905%; height: 66.3906px;">0</td><td style="width: 8.65266%; height: 66.3906px;">  
</td></tr><tr style="height: 83.1875px;"><td style="width: 20.3956%; height: 83.1875px;">exception\_scan\_interval</td><td style="width: 8.40544%; height: 83.1875px;">integer,

string

</td><td style="width: 24.5983%; height: 83.1875px;">Time between exception scan (classes 1,2,3) intervals in seconds. Set to 0 to disable.</td><td style="width: 6.30408%; height: 83.1875px;">No</td><td style="width: 6.30408%; height: 83.1875px;">No</td><td style="width: 16.8109%; height: 83.1875px;">0</td><td style="width: 8.52905%; height: 83.1875px;">0</td><td style="width: 8.65266%; height: 83.1875px;">  
</td></tr><tr style="height: 99.9844px;"><td style="width: 20.3956%; height: 99.9844px;">integrity\_scan\_interval</td><td style="width: 8.40544%; height: 99.9844px;">integer,

string

</td><td style="width: 24.5983%; height: 99.9844px;">Time between integrity scan (classes 0,1,2,3) intervals in seconds (general interrogation). Set to 0 to disable.</td><td style="width: 6.30408%; height: 99.9844px;">No</td><td style="width: 6.30408%; height: 99.9844px;">No</td><td style="width: 16.8109%; height: 99.9844px;">0</td><td style="width: 8.52905%; height: 99.9844px;">0</td><td style="width: 8.65266%; height: 99.9844px;">  
</td></tr><tr style="height: 124.797px;"><td style="width: 20.3956%; height: 124.797px;">timesync\_mode</td><td style="width: 8.40544%; height: 124.797px;">string</td><td style="width: 24.5983%; height: 124.797px;">Will override masters default setting for choosing timesync procedure</td><td style="width: 6.30408%; height: 124.797px;">No</td><td style="width: 6.30408%; height: 124.797px;">No</td><td style="width: 16.8109%; height: 124.797px;">NON-LAN (for Serial)

LAN (for tcp)

</td><td colspan="2" style="width: 17.1817%; height: 124.797px;">LAN, NON-LAN

</td></tr><tr style="height: 192.125px;"><td style="width: 20.3956%; height: 192.125px;">time\_sync\_interval\_sec

</td><td style="width: 8.40544%; height: 192.125px;">integer,

string

</td><td style="width: 24.5983%; height: 192.125px;">Periodic time sync interval in seconds.

If &gt; 0 ­- time syncs are forced and periodic.

If = 0 ­- time syncs react to IIN bits from slave.

If &lt; 0 -­ time syncs are disabled.

</td><td style="width: 6.30408%; height: 192.125px;">No</td><td style="width: 6.30408%; height: 192.125px;">No</td><td style="width: 16.8109%; height: 192.125px;">  
</td><td style="width: 8.52905%; height: 192.125px;">  
</td><td style="width: 8.65266%; height: 192.125px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 20.3956%; height: 46.5938px;">select\_ms</td><td style="width: 8.40544%; height: 46.5938px;">integer</td><td style="width: 24.5983%; height: 46.5938px;">Select command timeout. Valid for all signals.</td><td style="width: 6.30408%; height: 46.5938px;">No</td><td style="width: 6.30408%; height: 46.5938px;">No</td><td style="width: 16.8109%; height: 46.5938px;">10000</td><td style="width: 8.52905%; height: 46.5938px;">  
</td><td style="width: 8.65266%; height: 46.5938px;">  
</td></tr><tr style="height: 49.5938px;"><td style="width: 20.3956%; height: 49.5938px;">timeout\_ms</td><td style="width: 8.40544%; height: 49.5938px;">integer</td><td style="width: 24.5983%; height: 49.5938px;">Response timeout in milliseconds</td><td style="width: 6.30408%; height: 49.5938px;">No

</td><td style="width: 6.30408%; height: 49.5938px;">No</td><td style="width: 16.8109%; height: 49.5938px;">2000</td><td style="width: 8.52905%; height: 49.5938px;">  
</td><td style="width: 8.65266%; height: 49.5938px;">  
</td></tr><tr style="height: 63.3906px;"><td style="width: 20.3956%; height: 63.3906px;">keep\_alive\_timeout</td><td style="width: 8.40544%; height: 63.3906px;">integer</td><td style="width: 24.5983%; height: 63.3906px;">Time interval for sending a keep alive  
packet in milliseconds.</td><td style="width: 6.30408%; height: 63.3906px;">No</td><td style="width: 6.30408%; height: 63.3906px;">-</td><td style="width: 16.8109%; height: 63.3906px;">60</td><td style="width: 8.52905%; height: 63.3906px;">  
</td><td style="width: 8.65266%; height: 63.3906px;">  
</td></tr></tbody></table>

#####  DNP3 Master parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr-0" style="border-collapse: collapse; width: 100%; height: 1353.97px;"><tbody><tr style="height: 80.1719px;"><th rowspan="2" style="width: 18.047%; height: 110.266px;">**Parameter**  
  
</th><th rowspan="2" style="width: 8.77627%; height: 110.266px;">**Type**  
  
</th><th rowspan="2" style="width: 28.9246%; height: 110.266px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 10.8776%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 11.1248%; height: 110.266px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 22.2497%; height: 80.1719px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 5.43881%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 5.43881%; height: 30.0938px;">RTU</th><th class="align-center" style="width: 11.1248%; height: 30.0938px;">Min</th><th class="align-center" style="width: 11.1248%; height: 30.0938px;">Max</th></tr><tr style="height: 35.3906px;"><td style="width: 18.047%; height: 35.3906px;">signal\_name</td><td style="width: 8.77627%; height: 35.3906px;">string</td><td style="width: 28.9246%; height: 35.3906px;">User-friendly signal name</td><td style="width: 5.43881%; height: 35.3906px;">Yes</td><td style="width: 5.43881%; height: 35.3906px;">Yes</td><td style="width: 11.1248%; height: 35.3906px;"></td><td style="width: 11.1248%; height: 35.3906px;">  
</td><td style="width: 11.1248%; height: 35.3906px;"></td></tr><tr style="height: 35.375px;"><td style="width: 18.047%; height: 35.375px;">device\_alias</td><td style="width: 8.77627%; height: 35.375px;">string</td><td style="width: 28.9246%; height: 35.375px;">Device alias from a Devices tab</td><td style="width: 5.43881%; height: 35.375px;">Yes</td><td style="width: 5.43881%; height: 35.375px;">Yes</td><td style="width: 11.1248%; height: 35.375px;">  
</td><td style="width: 11.1248%; height: 35.375px;">  
</td><td style="width: 11.1248%; height: 35.375px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 18.047%; height: 46.5938px;">signal\_alias</td><td style="width: 8.77627%; height: 46.5938px;"><div><div>string</div></div></td><td style="width: 28.9246%; height: 46.5938px;">Unique alphanumeric name of the signal to be used</td><td style="width: 5.43881%; height: 46.5938px;">Yes</td><td style="width: 5.43881%; height: 46.5938px;">Yes</td><td style="width: 11.1248%; height: 46.5938px;">  
</td><td style="width: 11.1248%; height: 46.5938px;">  
</td><td style="width: 11.1248%; height: 46.5938px;">  
</td></tr><tr style="height: 35.375px;"><td style="width: 18.047%; height: 35.375px;">enable</td><td style="width: 8.77627%; height: 35.375px;">boolean</td><td style="width: 28.9246%; height: 35.375px;">Enabling/disabling a device</td><td style="width: 5.43881%; height: 35.375px;">No</td><td style="width: 5.43881%; height: 35.375px;">No</td><td style="width: 11.1248%; height: 35.375px;">1</td><td style="width: 11.1248%; height: 35.375px;">0</td><td style="width: 11.1248%; height: 35.375px;">1</td></tr><tr style="height: 35.375px;"><td style="width: 18.047%; height: 35.375px;">index</td><td style="width: 8.77627%; height: 35.375px;">integer</td><td style="width: 28.9246%; height: 35.375px;">Index of a signal.</td><td style="width: 5.43881%; height: 35.375px;">Yes</td><td style="width: 5.43881%; height: 35.375px;">Yes</td><td style="width: 11.1248%; height: 35.375px;">  
</td><td style="width: 11.1248%; height: 35.375px;">0</td><td style="width: 11.1248%; height: 35.375px;">65535</td></tr><tr style="height: 35.375px;"><td style="width: 18.047%; height: 35.375px;">log</td><td style="width: 8.77627%; height: 35.375px;">boolean</td><td style="width: 28.9246%; height: 35.375px;">Enable logging in the event log</td><td style="width: 5.43881%; height: 35.375px;">No</td><td style="width: 5.43881%; height: 35.375px;">No</td><td style="width: 11.1248%; height: 35.375px;">0</td><td style="width: 11.1248%; height: 35.375px;">0</td><td style="width: 11.1248%; height: 35.375px;">1</td></tr><tr style="height: 262.047px;"><td style="width: 18.047%; height: 262.047px;">signal\_type</td><td style="width: 8.77627%; height: 262.047px;">string</td><td style="width: 28.9246%; height: 262.047px;">DNP3 signal type. (case  
insensitive)  
  
</td><td style="width: 5.43881%; height: 262.047px;">Yes</td><td style="width: 5.43881%; height: 262.047px;">Yes</td><td style="width: 11.1248%; height: 262.047px;">  
</td><td colspan="2" style="width: 22.2497%; height: 262.047px;">”binary”,

”doublebitbinary”,

”binaryoutputstatus”,

”binaryoutputcommand”,

”counter”,

”frozencounter”,  
”analog”,  
”analogoutputstatus”,

”analogoutputcommand”,

”timeandinterval”,  
”octetstring”

</td></tr><tr style="height: 102.562px;"><td style="width: 18.047%; height: 102.562px;">command\_variation</td><td style="width: 8.77627%; height: 102.562px;">integer</td><td style="width: 28.9246%; height: 102.562px;">DNP3 command variation.  
*Supported variations depend on signal type and are provided in the table below*

</td><td style="width: 5.43881%; height: 102.562px;">No</td><td style="width: 5.43881%; height: 102.562px;">No</td><td style="width: 11.1248%; height: 102.562px;">1</td><td style="width: 11.1248%; height: 102.562px;">0</td><td style="width: 11.1248%; height: 102.562px;">4</td></tr><tr style="height: 80.1875px;"><td style="width: 18.047%; height: 80.1875px;">static\_variation</td><td style="width: 8.77627%; height: 80.1875px;">integer</td><td style="width: 28.9246%; height: 80.1875px;">DNP3 command variation (). Supported variations depend  
on signal type and are provided in the table below.</td><td style="width: 5.43881%; height: 80.1875px;">No</td><td style="width: 5.43881%; height: 80.1875px;">No</td><td style="width: 11.1248%; height: 80.1875px;">  
</td><td colspan="2" style="width: 22.2497%; height: 80.1875px;">0, 1, 2, 3, 4, 5, 6, 9, 10</td></tr><tr style="height: 83.1875px;"><td style="width: 18.047%; height: 83.1875px;">event\_variation</td><td style="width: 8.77627%; height: 83.1875px;">integer</td><td style="width: 28.9246%; height: 83.1875px;">DNP3 command variation. Supported variations depend on signal type and are provided in the table below.</td><td style="width: 5.43881%; height: 83.1875px;">No

</td><td style="width: 5.43881%; height: 83.1875px;">No</td><td style="width: 11.1248%; height: 83.1875px;">  
</td><td style="width: 11.1248%; height: 83.1875px;">0</td><td style="width: 11.1248%; height: 83.1875px;">8</td></tr><tr style="height: 102.562px;"><td style="width: 18.047%; height: 102.562px;">control\_code</td><td style="width: 8.77627%; height: 102.562px;"><div><div>string</div></div></td><td style="width: 28.9246%; height: 102.562px;">DNP3 control model code of CROB signal. TripClose and Pulse control model requires **PulseOn/off** times to be set

</td><td style="width: 5.43881%; height: 102.562px;">Yes</td><td style="width: 5.43881%; height: 102.562px;">Yes</td><td style="width: 11.1248%; height: 102.562px;">  
</td><td colspan="2" style="width: 22.2497%; height: 102.562px;">LATCH, PULSE, TRIPCLOSE</td></tr><tr style="height: 63.3906px;"><td style="width: 18.047%; height: 63.3906px;">pulse\_on\_time\_ms</td><td style="width: 8.77627%; height: 63.3906px;">integer</td><td style="width: 28.9246%; height: 63.3906px;">Pulse ON time in milliseconds, when using Pulse or TripClose control models must be set</td><td style="width: 5.43881%; height: 63.3906px;">Yes</td><td style="width: 5.43881%; height: 63.3906px;">Yes</td><td style="width: 11.1248%; height: 63.3906px;">  
</td><td style="width: 11.1248%; height: 63.3906px;">  
</td><td style="width: 11.1248%; height: 63.3906px;">  
</td></tr><tr style="height: 63.3906px;"><td style="width: 18.047%; height: 63.3906px;">pulse\_off\_time\_ms</td><td style="width: 8.77627%; height: 63.3906px;">integer</td><td style="width: 28.9246%; height: 63.3906px;">Pulse OFF time in milliseconds, when using Pulse or TripClose control models must be set</td><td style="width: 5.43881%; height: 63.3906px;">Yes</td><td style="width: 5.43881%; height: 63.3906px;">Yes</td><td style="width: 11.1248%; height: 63.3906px;">  
</td><td style="width: 11.1248%; height: 63.3906px;">  
</td><td style="width: 11.1248%; height: 63.3906px;">  
</td></tr><tr style="height: 35.375px;"><td style="width: 18.047%; height: 35.375px;">class\_num</td><td style="width: 8.77627%; height: 35.375px;">integer</td><td style="width: 28.9246%; height: 35.375px;">Class assignment of the signal.</td><td style="width: 5.43881%; height: 35.375px;">No</td><td style="width: 5.43881%; height: 35.375px;">No</td><td style="width: 11.1248%; height: 35.375px;">0</td><td style="width: 11.1248%; height: 35.375px;">0</td><td style="width: 11.1248%; height: 35.375px;">3</td></tr><tr style="height: 124.953px;"><td style="width: 18.047%; height: 124.953px;">operate\_type</td><td style="width: 8.77627%; height: 124.953px;">integer</td><td style="width: 28.9246%; height: 124.953px;">Default command behaviour. IF selected

”­**-1**” ­- DirectOperateNoAck (FC=6),

**”0”** - DirectOperate (FC=5),

"**1"** - SelectBeforeOperate (FC=3).

</td><td style="width: 5.43881%; height: 124.953px;">No</td><td style="width: 5.43881%; height: 124.953px;">No</td><td style="width: 11.1248%; height: 124.953px;">1</td><td style="width: 11.1248%; height: 124.953px;">-1</td><td style="width: 11.1248%; height: 124.953px;">1</td></tr><tr style="height: 102.562px;"><td style="width: 18.047%; height: 102.562px;">job\_todo</td><td style="width: 8.77627%; height: 102.562px;">string</td><td style="width: 28.9246%; height: 102.562px;">The device status signal can be configured by providing one of the given values.  
  
</td><td style="width: 5.43881%; height: 102.562px;">No</td><td style="width: 5.43881%; height: 102.562px;">No</td><td style="width: 11.1248%; height: 102.562px;">  
</td><td colspan="2" style="width: 22.2497%; height: 102.562px;">communication\_status,  
device\_running,  
device\_error,  
unknown\_error

</td></tr></tbody></table>

##### Device status signals

To configure any device status signal for DNP3 protocol additional job\_todo column is required. For DNP3 master required parameters for status signal will be: **signal\_name,** **device\_alias, signal\_alias, index, signal\_type**, **event\_variation** (1,2 or 3) and **job\_todo**. There are 4 possible signals: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

##### Command variations

<table border="1" id="bkmrk-signal-type-availabl" style="border-collapse: collapse; width: 100%; height: 87px;"><tbody><tr style="height: 29px;"><td class="align-center" style="width: 33.3333%; height: 29px;">Signal Type</td><td class="align-center" style="width: 33.3333%; height: 29px;">Available Command Variation</td><td class="align-center" style="width: 33.3333%; height: 29px;">Default Command Variation</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Binary Output Command (Group12)</td><td style="width: 33.3333%; height: 29px;">0, 1</td><td class="align-center" style="width: 33.3333%; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Analog Output Command (Group41)</td><td style="width: 33.3333%; height: 29px;">0, 1, 2, 3, 4</td><td class="align-center" style="width: 33.3333%; height: 29px;">1</td></tr></tbody></table>

##### Static and Event variations

<table border="1" id="bkmrk-signal-type-availabl-0" style="border-collapse: collapse; width: 100%; height: 291px;"><tbody><tr style="height: 29px;"><td class="align-center" style="width: 33.3333%; height: 29px;">Signal Type</td><td class="align-center" style="width: 40.1234%; height: 29px;">Available Variations</td><td class="align-center" style="width: 26.5432%; height: 29px;">Default Variations</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Binary</td><td style="width: 40.1234%; height: 29px;">Static variation (Group1) 1, 2  
Event variation (Group2) 1, 2, 3</td><td style="width: 26.5432%; height: 29px;">Static variation 2  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Double Binary</td><td style="width: 40.1234%; height: 29px;">Static variation (Group3) 2  
Event variation (Group4) 1, 2, 3</td><td style="width: 26.5432%; height: 29px;">Static variation 2  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Binary Output Status</td><td style="width: 40.1234%; height: 29px;">Static variation (Group10) 1, 2  
Event variation (Group11) 1, 2</td><td style="width: 26.5432%; height: 29px;">Static variation 2  
Event variation 1</td></tr><tr style="height: 30px;"><td style="width: 33.3333%; height: 30px;">Counter</td><td style="width: 40.1234%; height: 30px;">Static variation (Group20) 1, 2, 5, 6  
Event variation (Group22) 1, 2, 5, 6</td><td style="width: 26.5432%; height: 30px;">Static variation 1  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Frozen Counter</td><td style="width: 40.1234%; height: 29px;">Static variations (Group21) 1, 2, 5, 6, 9,10  
Event variation (Group23) 1, 2, 5, 6</td><td style="width: 26.5432%; height: 29px;">Static variation 1  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Analog</td><td style="width: 40.1234%; height: 29px;">Static variation (Group30) 1, 2, 3, 4, 5, 6  
Event variation (Group32) 1, 2, 3, 4, 5, 6, 7, 8</td><td style="width: 26.5432%; height: 29px;">Static variation 1  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Analog Output Status</td><td style="width: 40.1234%; height: 29px;">Static variation (Group40) 1, 2, 3, 4  
Event variation (Group42) 1, 2, 3, 4, 5, 6, 7, 8</td><td style="width: 26.5432%; height: 29px;">Static variation 1  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Time and Interval</td><td style="width: 40.1234%; height: 29px;">Static variation (Group50) 1</td><td style="width: 26.5432%; height: 29px;">Static variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Octet String</td><td style="width: 40.1234%; height: 29px;">Static variation (Group110) 0  
Event variation (Group111) 0</td><td style="width: 26.5432%; height: 29px;">Static variation 0  
Event variation 0</td></tr></tbody></table>

#### Debugging the DNP3 Master service

If configuration for DNP3 devices is set up, handler for protocol will start automatically. If configuration is missing or contains errors, protocol will not start. It is done intentionally decrease unnecessary memory usage.

DNP3 protocol runs a service called **dnp3-­master**. If DNP3 does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from command line interface and find out why link is not functioning properly. To launch a debugging session, a user should stop **dnp3-­master** process and run **dnp3-m­aster** command with respective flags as in the table given below.

Procedure for DNP3 Master protocol service debugging:

- **Step 1**: Service must be stopped by entering the following command into the wcclite:  
    **/etc/init.d/dnp3-­master stop**
- **Step 2**: After service is stopped it must be started with the preferred configuration file (JSON files found in /etc/ folder) and a debug level 7: **dnp3­-master ­-c /etc/dnp3-­master/dnp3­master.json ­-d7**Additional output forming options described in the table below.
- **Step 3**: Once the problem is diagnosed normal operations can be resumed with the following command: **/etc/init.d/dnp3-­master start**

dnp3­-master command line debugging options

<table border="1" class="align-center" id="bkmrk-option%C2%A0-description-" style="border-collapse: collapse; width: 49.3298%; height: 328px;"><tbody><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">Option </td><td style="width: 64.9456%; height: 29px;">Description</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">­-h \[ –help \] </td><td style="width: 64.9456%; height: 29px;">Display help information</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">­-V \[ –version \] </td><td style="width: 64.9456%; height: 29px;">Show version</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">-p \[ –port \]</td><td style="width: 64.9456%; height: 29px;">­Show output for one port only</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">­-d &lt;debug level&gt;</td><td style="width: 64.9456%; height: 29px;">Set debugging level</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">-­c \[ –config \] </td><td style="width: 64.9456%; height: 29px;">Config path</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">-­a \[ –app \]</td><td style="width: 64.9456%; height: 29px;">Show application layer data</td></tr><tr style="height: 21px;"><td style="width: 35.0544%; height: 21px;">–l \[ –link \] </td><td style="width: 64.9456%; height: 21px;">Show link layer data</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">–t \[ –transport \] </td><td style="width: 64.9456%; height: 29px;">Show transport layer data</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">-­r \[ –redis \] </td><td style="width: 64.9456%; height: 29px;">Show Redis messages</td></tr><tr style="height: 46px;"><td style="width: 35.0544%; height: 46px;">-­R \[ –readyfile \] </td><td style="width: 64.9456%; height: 46px;">Ready notification file</td></tr></tbody></table>

# 12.3 DNP 3.0 Slave

Default group and variation sets are used to send static and event values. If master devices support different groups and variations, they can be adjusted in Excel configuration. WCC Lite supported variations are provided in *Static and Event variations* and *Command variations.*

##### DNP3 Slave parameters for Devices tab

<table border="1" id="bkmrk-parameter-type-descr-1" style="border-collapse: collapse; width: 100%; height: 1683.85px;"><tbody><tr style="height: 80.1625px;"><th rowspan="2" style="width: 19.9011%; height: 110.25px;">**Parameter**  
  
</th><th rowspan="2" style="width: 10.011%; height: 110.25px;">**Type**  
  
</th><th rowspan="2" style="width: 24.7233%; height: 110.25px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 12.8554%; height: 80.1625px;">**Required**  
  
</th><th rowspan="2" style="width: 12.4845%; height: 110.25px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 20.0247%; height: 80.1625px;">**Range**  
  
</th></tr><tr style="height: 30.0875px;"><th class="align-center" style="width: 6.42769%; height: 30.0875px;">TCP/

TLS

</th><th class="align-center" style="width: 6.42769%; height: 30.0875px;">RTU</th><th class="align-center" style="width: 10.0124%; height: 30.0875px;">Min</th><th class="align-center" style="width: 10.0124%; height: 30.0875px;">Max</th></tr><tr style="height: 35.2px;"><td style="width: 19.9011%; height: 35.2px;">name</td><td style="width: 10.011%; height: 35.2px;">string </td><td style="width: 24.7233%; height: 35.2px;">User-friendly device name</td><td style="width: 6.42769%; height: 35.2px;">Yes</td><td style="width: 6.42769%; height: 35.2px;">Yes</td><td style="width: 12.4845%; height: 35.2px;"></td><td style="width: 10.0124%; height: 35.2px;">  
</td><td style="width: 10.0124%; height: 35.2px;"></td></tr><tr style="height: 35.2px;"><td style="width: 19.9011%; height: 35.2px;">description</td><td style="width: 10.011%; height: 35.2px;">string</td><td style="width: 24.7233%; height: 35.2px;">Description of a device</td><td style="width: 6.42769%; height: 35.2px;">No</td><td style="width: 6.42769%; height: 35.2px;">No</td><td style="width: 12.4845%; height: 35.2px;"></td><td style="width: 10.0124%; height: 35.2px;">  
</td><td style="width: 10.0124%; height: 35.2px;"></td></tr><tr style="height: 46.4px;"><td style="width: 19.9011%; height: 46.4px;">device\_alias</td><td style="width: 10.011%; height: 46.4px;">string</td><td style="width: 24.7233%; height: 46.4px;">Alphanumeric string to identify a device</td><td style="width: 6.42769%; height: 46.4px;">Yes</td><td style="width: 6.42769%; height: 46.4px;">Yes</td><td style="width: 12.4845%; height: 46.4px;">  
</td><td style="width: 10.0124%; height: 46.4px;">  
</td><td style="width: 10.0124%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 19.9011%; height: 46.4px;">enable</td><td style="width: 10.011%; height: 46.4px;">boolean</td><td style="width: 24.7233%; height: 46.4px;">Enabling/disabling of a device</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 12.4845%; height: 46.4px;">1</td><td style="width: 10.0124%; height: 46.4px;">0</td><td style="width: 10.0124%; height: 46.4px;">1</td></tr><tr style="height: 57.6px;"><td style="width: 19.9011%; height: 57.6px;">protocol</td><td style="width: 10.011%; height: 57.6px;">string</td><td style="width: 24.7233%; height: 57.6px;">Protocol to be used.</td><td style="width: 6.42769%; height: 57.6px;">Yes</td><td style="width: 6.42769%; height: 57.6px;">Yes</td><td style="width: 12.4845%; height: 57.6px;">  
</td><td colspan="2" style="width: 20.0247%; height: 57.6px;">dnp3 tcp slave

dnp3 serial slave

</td></tr><tr style="height: 113.6px;"><td style="width: 19.9011%; height: 113.6px;">mode</td><td style="width: 10.011%; height: 113.6px;">string</td><td style="width: 24.7233%; height: 113.6px;">Choosing between TCP, TLS and SERIAL modes. If protocol provided DNP3 TCP mode defaults to tcp and if DNP3 serial is provided mode defaults to SERIAL</td><td style="width: 6.42769%; height: 113.6px;">No</td><td style="width: 6.42769%; height: 113.6px;">No</td><td style="width: 12.4845%; height: 113.6px;">TCP or SERIAL</td><td colspan="2" style="width: 20.0247%; height: 113.6px;">TCP, SERIAL, TLS</td></tr><tr style="height: 29.6px;"><td style="width: 19.9011%; height: 29.6px;">host</td><td style="width: 10.011%; height: 29.6px;">string</td><td style="width: 24.7233%; height: 29.6px;">IP address of TCP slave device</td><td style="width: 6.42769%; height: 29.6px;">Yes</td><td style="width: 6.42769%; height: 29.6px;">-</td><td style="width: 12.4845%; height: 29.6px;">  
</td><td style="width: 10.0124%; height: 29.6px;">  
</td><td style="width: 10.0124%; height: 29.6px;">  
</td></tr><tr style="height: 63.2px;"><td style="width: 19.9011%; height: 63.2px;">bind\_address </td><td style="width: 10.011%; height: 63.2px;">string</td><td style="width: 24.7233%; height: 63.2px;">IP address of network adapter used to connect to slave device</td><td style="width: 6.42769%; height: 63.2px;">No </td><td style="width: 6.42769%; height: 63.2px;">-</td><td style="width: 12.4845%; height: 63.2px;">0.0.0.0</td><td style="width: 10.0124%; height: 63.2px;">  
</td><td style="width: 10.0124%; height: 63.2px;">  
</td></tr><tr style="height: 36px;"><td style="width: 19.9011%; height: 36px;">port</td><td style="width: 10.011%; height: 36px;">integer</td><td style="width: 24.7233%; height: 36px;">TCP communication port</td><td style="width: 6.42769%; height: 36px;">No </td><td style="width: 6.42769%; height: 36px;">-</td><td style="width: 12.4845%; height: 36px;">20000</td><td style="width: 10.0124%; height: 36px;">  
</td><td style="width: 10.0124%; height: 36px;">  
</td></tr><tr style="height: 56px;"><td style="width: 19.9011%; height: 56px;">device</td><td style="width: 10.011%; height: 56px;">string</td><td style="width: 24.7233%; height: 56px;">Communication port (”PORT1” or ”PORT2”)</td><td style="width: 6.42769%; height: 56px;">-</td><td style="width: 6.42769%; height: 56px;">Yes</td><td style="width: 12.4845%; height: 56px;">  
</td><td style="width: 10.0124%; height: 56px;">  
</td><td style="width: 10.0124%; height: 56px;">  
</td></tr><tr style="height: 63.2px;"><td style="width: 19.9011%; height: 63.2px;">baudrate</td><td style="width: 10.011%; height: 63.2px;">integer</td><td style="width: 24.7233%; height: 63.2px;">Communication speed, bauds/s</td><td style="width: 6.42769%; height: 63.2px;">-</td><td style="width: 6.42769%; height: 63.2px;">No</td><td style="width: 12.4845%; height: 63.2px;">9600</td><td colspan="2" style="width: 20.0247%; height: 63.2px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200</td></tr><tr style="height: 46.4px;"><td style="width: 19.9011%; height: 46.4px;">databits</td><td style="width: 10.011%; height: 46.4px;">integer</td><td style="width: 24.7233%; height: 46.4px;">Data bit count for communication</td><td style="width: 6.42769%; height: 46.4px;">-</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 12.4845%; height: 46.4px;">8</td><td style="width: 10.0124%; height: 46.4px;">6</td><td style="width: 10.0124%; height: 46.4px;">9</td></tr><tr style="height: 46.4px;"><td style="width: 19.9011%; height: 46.4px;">stopbits</td><td style="width: 10.011%; height: 46.4px;">integer</td><td style="width: 24.7233%; height: 46.4px;">Stop bit count for communication</td><td style="width: 6.42769%; height: 46.4px;">-</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 12.4845%; height: 46.4px;">1</td><td style="width: 10.0124%; height: 46.4px;">1</td><td style="width: 10.0124%; height: 46.4px;">2</td></tr><tr style="height: 29.6px;"><td style="width: 19.9011%; height: 29.6px;">parity</td><td style="width: 10.011%; height: 29.6px;">string</td><td style="width: 24.7233%; height: 29.6px;">Communication parity option</td><td style="width: 6.42769%; height: 29.6px;">-</td><td style="width: 6.42769%; height: 29.6px;">No</td><td style="width: 12.4845%; height: 29.6px;">none</td><td colspan="2" style="width: 20.0247%; height: 29.6px;">none, even, odd</td></tr><tr style="height: 46.4px;"><td style="width: 19.9011%; height: 46.4px;">flowcontrol</td><td style="width: 10.011%; height: 46.4px;">string</td><td style="width: 24.7233%; height: 46.4px;">Communication device flow control option. </td><td style="width: 6.42769%; height: 46.4px;">-</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 12.4845%; height: 46.4px;">none</td><td colspan="2" style="height: 46.4px; width: 20.0247%;">none</td></tr><tr style="height: 63.2px;"><td style="width: 19.9011%; height: 63.2px;">tls</td><td style="width: 10.011%; height: 63.2px;">boolean</td><td style="width: 24.7233%; height: 63.2px;">Enable/disable use of TLS  
  
</td><td style="width: 6.42769%; height: 63.2px;">Yes (for  
TLS)</td><td style="width: 6.42769%; height: 63.2px;">-</td><td style="width: 12.4845%; height: 63.2px;">0</td><td style="height: 63.2px; width: 10.0124%;">0</td><td style="width: 10.0124%; height: 63.2px;">1</td></tr><tr style="height: 63.2px;"><td style="width: 19.9011%; height: 63.2px;">tls\_local\_certificate</td><td style="width: 10.011%; height: 63.2px;">string</td><td style="width: 24.7233%; height: 63.2px;">Local certificate for TLS connection</td><td style="width: 6.42769%; height: 63.2px;">Yes (for TLS)</td><td style="width: 6.42769%; height: 63.2px;">-</td><td style="width: 12.4845%; height: 63.2px;">  
</td><td style="height: 63.2px; width: 10.0124%;">  
</td><td style="width: 10.0124%; height: 63.2px;">  
</td></tr><tr style="height: 63.2px;"><td style="width: 19.9011%; height: 63.2px;">tls\_peer\_certificate</td><td style="width: 10.011%; height: 63.2px;">string</td><td style="width: 24.7233%; height: 63.2px;">Certificate authority file for TLS connection</td><td style="width: 6.42769%; height: 63.2px;">No (for  
TLS)</td><td style="width: 6.42769%; height: 63.2px;">-</td><td style="width: 12.4845%; height: 63.2px;">  
</td><td style="height: 63.2px; width: 10.0124%;">  
</td><td style="width: 10.0124%; height: 63.2px;">  
</td></tr><tr style="height: 63.2px;"><td style="width: 19.9011%; height: 63.2px;">tls\_private\_key</td><td style="width: 10.011%; height: 63.2px;">string</td><td style="width: 24.7233%; height: 63.2px;">File consisting of private key for TLS connection</td><td style="width: 6.42769%; height: 63.2px;">No (for  
TLS)</td><td style="width: 6.42769%; height: 63.2px;">-</td><td style="width: 12.4845%; height: 63.2px;">  
</td><td style="width: 10.0124%; height: 63.2px;">  
</td><td style="width: 10.0124%; height: 63.2px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 19.9011%; height: 46.4px;">max\_tx\_frag\_size</td><td style="width: 10.011%; height: 46.4px;">integer</td><td style="width: 24.7233%; height: 46.4px;">Maximum size of a received fragment.</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 12.4845%; height: 46.4px;">2048</td><td style="width: 10.0124%; height: 46.4px;">0</td><td style="width: 10.0124%; height: 46.4px;">2048</td></tr><tr style="height: 29.6px;"><td style="width: 19.9011%; height: 29.6px;">destination\_address</td><td style="width: 10.011%; height: 29.6px;">integer</td><td style="width: 24.7233%; height: 29.6px;">Address of a master station</td><td style="width: 6.42769%; height: 29.6px;">No</td><td style="width: 6.42769%; height: 29.6px;">No</td><td style="width: 12.4845%; height: 29.6px;">1</td><td style="width: 10.0124%; height: 29.6px;">0</td><td style="width: 10.0124%; height: 29.6px;">65535</td></tr><tr style="height: 46.4px;"><td style="width: 19.9011%; height: 46.4px;">source\_address</td><td style="width: 10.011%; height: 46.4px;">integer</td><td style="width: 24.7233%; height: 46.4px;">Address of a slave (local) station.</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 12.4845%; height: 46.4px;">1</td><td style="width: 10.0124%; height: 46.4px;">0</td><td style="width: 10.0124%; height: 46.4px;">65535</td></tr><tr style="height: 96.8px;"><td style="width: 19.9011%; height: 96.8px;">unsol\_classes</td><td style="width: 10.011%; height: 96.8px;">string</td><td style="width: 24.7233%; height: 96.8px;">Defines which classes will have unsolicited actions on startup. (Example: "1,3,2")</td><td style="width: 6.42769%; height: 96.8px;">No</td><td style="width: 6.42769%; height: 96.8px;">No</td><td style="width: 12.4845%; height: 96.8px;">no class</td><td style="width: 10.0124%; height: 96.8px;">1</td><td style="width: 10.0124%; height: 96.8px;">3</td></tr><tr style="height: 192px;"><td style="width: 19.9011%; height: 192px;">time\_sync\_interval\_sec

</td><td style="width: 10.011%; height: 192px;">integer,

string

</td><td style="width: 24.7233%; height: 192px;">Periodic time sync interval in seconds.

If 0 &lt; ­- time syncs are forced and periodic.

If = 0 ­- time syncs react to IIN bits from slave.

If &lt; 0 -­ time syncs are disabled.

</td><td style="width: 6.42769%; height: 192px;">No</td><td style="width: 6.42769%; height: 192px;">No</td><td style="width: 12.4845%; height: 192px;">0</td><td style="width: 10.0124%; height: 192px;">0</td><td style="width: 10.0124%; height: 192px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 19.9011%; height: 46.4px;">select\_ms</td><td style="width: 10.011%; height: 46.4px;">integer</td><td style="width: 24.7233%; height: 46.4px;">Select command timeout. Valid for all signals.</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 6.42769%; height: 46.4px;">No</td><td style="width: 12.4845%; height: 46.4px;">10000</td><td style="width: 10.0124%; height: 46.4px;">  
</td><td style="width: 10.0124%; height: 46.4px;">  
</td></tr><tr style="height: 48.8px;"><td style="width: 19.9011%; height: 48.8px;">timeout\_ms</td><td style="width: 10.011%; height: 48.8px;">integer</td><td style="width: 24.7233%; height: 48.8px;">Response timeout in milliseconds</td><td style="width: 6.42769%; height: 48.8px;">No

</td><td style="width: 6.42769%; height: 48.8px;">No</td><td style="width: 12.4845%; height: 48.8px;">2000</td><td style="width: 10.0124%; height: 48.8px;">  
</td><td style="width: 10.0124%; height: 48.8px;">  
</td></tr><tr style="height: 63.2px;"><td style="width: 19.9011%; height: 63.2px;">keep\_alive\_timeout</td><td style="width: 10.011%; height: 63.2px;">integer</td><td style="width: 24.7233%; height: 63.2px;">Time interval for sending a keep alive  
packet in milliseconds.</td><td style="width: 6.42769%; height: 63.2px;">No</td><td style="width: 6.42769%; height: 63.2px;">No</td><td style="width: 12.4845%; height: 63.2px;">60</td><td style="width: 10.0124%; height: 63.2px;">  
</td><td style="width: 10.0124%; height: 63.2px;">  
</td></tr></tbody></table>

##### DNP3 Slave parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr-2" style="border-collapse: collapse; width: 100%; height: 569px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 17.1817%; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 9.39431%; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 29.2937%; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 11.4974%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 10.2596%; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 22.2497%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 5.06966%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 6.42769%; height: 30.0938px;">RTU</th><th class="align-center" style="width: 11.1248%; height: 30.0938px;">Min</th><th class="align-center" style="width: 11.1248%; height: 30.0938px;">Max</th></tr><tr style="height: 35px;"><td style="width: 17.1817%; height: 10px;">signal\_name</td><td style="width: 9.39431%; height: 10px;">string</td><td style="width: 29.2937%; height: 10px;">User-friendly signal name</td><td style="width: 5.06966%; height: 10px;">Yes</td><td style="width: 6.42769%; height: 10px;">Yes</td><td style="width: 10.2596%; height: 10px;"></td><td style="width: 11.1248%; height: 10px;">  
</td><td style="width: 11.1248%; height: 10px;"></td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 29px;">device\_alias</td><td style="width: 9.39431%; height: 29px;">string</td><td style="width: 29.2937%; height: 29px;">Device alias from a Devices tab</td><td style="width: 5.06966%; height: 29px;">Yes</td><td style="width: 6.42769%; height: 10px;">Yes</td><td style="width: 10.2596%; height: 29px;">  
</td><td style="width: 11.1248%; height: 29px;">  
</td><td style="width: 11.1248%; height: 29px;">  
</td></tr><tr style="height: 46px;"><td style="width: 17.1817%; height: 46px;">signal\_alias</td><td style="width: 9.39431%; height: 46px;"><div><div>string</div></div></td><td style="width: 29.2937%; height: 46px;">Unique alphanumeric name of the signal to be used</td><td style="width: 5.06966%; height: 46px;">Yes</td><td style="width: 6.42769%; height: 10px;">Yes</td><td style="width: 10.2596%; height: 46px;">  
</td><td style="width: 11.1248%; height: 46px;">  
</td><td style="width: 11.1248%; height: 46px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 29px;">enable</td><td style="width: 9.39431%; height: 29px;">boolean</td><td style="width: 29.2937%; height: 29px;">Enabling/disabling of a device</td><td style="width: 5.06966%; height: 29px;">No</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%; height: 29px;">1</td><td style="width: 11.1248%; height: 29px;">0</td><td style="width: 11.1248%; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 10px;">index</td><td style="width: 9.39431%; height: 10px;">integer</td><td style="width: 29.2937%; height: 10px;">Index of a signal.</td><td style="width: 5.06966%; height: 10px;">Yes</td><td style="width: 6.42769%; height: 10px;">Yes</td><td style="width: 10.2596%; height: 10px;">  
</td><td style="width: 11.1248%; height: 10px;">0</td><td style="width: 11.1248%; height: 10px;">65535</td></tr><tr><td style="width: 17.1817%;">log</td><td style="width: 9.39431%;">bolean</td><td style="width: 29.2937%;">Enable logging in event log</td><td style="width: 5.06966%;">No</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%;">0</td><td style="width: 11.1248%;">0</td><td style="width: 11.1248%;">  
</td></tr><tr><td style="width: 17.1817%;">deadband</td><td style="width: 9.39431%;">integer, string</td><td style="width: 29.2937%;">Deadband for Analog, Analog Output Status, Counter, Frozen Counter signals.</td><td style="width: 5.06966%;">No</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%;">0</td><td style="width: 11.1248%;">  
</td><td style="width: 11.1248%;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 29px;">signal\_type</td><td style="width: 9.39431%; height: 29px;">string</td><td style="width: 29.2937%; height: 29px;">DNP3 signal type. (case  
insensitive)  
  
</td><td style="width: 5.06966%; height: 29px;">Yes</td><td style="width: 6.42769%; height: 10px;">Yes</td><td style="width: 10.2596%; height: 29px;">  
</td><td colspan="2" style="width: 22.2497%; height: 29px;">”binary”,

”doublebitbinary”,

”binaryoutputstatus”,

”binaryoutputcommand”,

”counter”,

”frozencounter”,  
”analog”,  
”analogoutputstatus”,

”analogoutputcommand”,

”timeandinterval”,  
”octetstring”

</td></tr><tr style="height: 113px;"><td style="width: 17.1817%; height: 71px;">command\_variation</td><td style="width: 9.39431%; height: 71px;">integer</td><td style="width: 29.2937%; height: 71px;">DNP3 command variation. *Supported variations depend on signal type and are provided in table below*

</td><td style="width: 5.06966%; height: 71px;">No</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%; height: 71px;">1</td><td style="width: 11.1248%; height: 71px;">0</td><td style="width: 11.1248%; height: 71px;">4</td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 29px;">static\_variation</td><td style="width: 9.39431%; height: 29px;">integer</td><td style="width: 29.2937%; height: 29px;">Override default signal’s static variation. Valid for Status mode signals.</td><td style="width: 5.06966%; height: 29px;">No</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%; height: 29px;">  
</td><td colspan="2" style="width: 22.2497%; height: 29px;">0, 1, 2, 3, 4, 5, 6, 9, 10</td></tr><tr style="height: 35px;"><td style="width: 17.1817%; height: 35px;">event\_variation</td><td style="width: 9.39431%; height: 35px;">integer</td><td style="width: 29.2937%; height: 35px;">Override default signal’s event variation. Valid for Status mode signals.

</td><td style="width: 5.06966%; height: 35px;">No

</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%; height: 35px;">  
</td><td style="width: 11.1248%; height: 35px;">0</td><td style="width: 11.1248%; height: 35px;">8</td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 29px;">control\_code</td><td style="width: 9.39431%; height: 29px;"><div><div>string</div></div></td><td style="width: 29.2937%; height: 29px;">DNP3 control model code of CROB signal. TripClose and Pulse controlmodel requires **PulseOn/off** times to be set

</td><td style="width: 5.06966%; height: 29px;">Yes</td><td style="width: 6.42769%; height: 10px;">Yes</td><td style="width: 10.2596%; height: 29px;">  
</td><td colspan="2" style="width: 22.2497%; height: 29px;">LATCH, PULSE, TRIPCLOSE</td></tr><tr style="height: 80px;"><td style="width: 17.1817%; height: 80px;">pulse\_on\_time\_ms</td><td style="width: 9.39431%; height: 80px;">integer</td><td style="width: 29.2937%; height: 80px;">Pulse ON time in milliseconds, when using Pulse or TripClose control models must be set</td><td style="width: 5.06966%; height: 80px;">Yes</td><td style="width: 6.42769%; height: 10px;">Yes</td><td style="width: 10.2596%; height: 80px;">  
</td><td style="width: 11.1248%; height: 80px;">  
</td><td style="width: 11.1248%; height: 80px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 29px;">pulse\_off\_time\_ms</td><td style="width: 9.39431%; height: 29px;">integer</td><td style="width: 29.2937%; height: 29px;">Pulse OFF time in milliseconds, when using Pulse or TripClose control models must be set</td><td style="width: 5.06966%; height: 29px;">Yes</td><td style="width: 6.42769%; height: 10px;">Yes</td><td style="width: 10.2596%; height: 29px;">  
</td><td style="width: 11.1248%; height: 29px;">  
</td><td style="width: 11.1248%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 29px;">class\_num</td><td style="width: 9.39431%; height: 29px;">integer</td><td style="width: 29.2937%; height: 29px;">Class assignment of this signal.</td><td style="width: 5.06966%; height: 29px;">No</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%; height: 29px;">0</td><td style="width: 11.1248%; height: 29px;">0</td><td style="width: 11.1248%; height: 29px;">3</td></tr><tr style="height: 46px;"><td style="width: 17.1817%; height: 31px;">operate\_type</td><td style="width: 9.39431%; height: 31px;">integer</td><td style="width: 29.2937%; height: 31px;">Default command behaviour.

If selected:

”­**-1**” ­- DirectOperateNoAck (FC=6),

**”0”** - DirectOperate (FC=5),

"**1"** -­ SelectBeforeOperate (FC=3).

</td><td style="width: 5.06966%; height: 31px;">No</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%; height: 31px;">1</td><td style="width: 11.1248%; height: 31px;">-1</td><td style="width: 11.1248%; height: 31px;">1</td></tr><tr style="height: 29px;"><td style="width: 17.1817%; height: 29px;">job\_todo</td><td style="width: 9.39431%; height: 29px;">string</td><td style="width: 29.2937%; height: 29px;">Device status signal can be configured by providing one of the given values.  
  
</td><td style="width: 5.06966%; height: 29px;">No</td><td style="width: 6.42769%; height: 10px;">No</td><td style="width: 10.2596%; height: 29px;">  
</td><td colspan="2" style="width: 22.2497%; height: 29px;">communication\_status,  
device\_running,  
device\_error,  
unknown\_error

</td></tr></tbody></table>

##### Device status signals

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk-" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>To configure any device status signal for DNP3 protocol additional job\_todo column is required. For DNP3 slave required parameters for status signal will be: **signal\_name, device\_alias, signal\_alias, index, signal\_type**, **event\_variation** (1,2 or 3) and **job\_todo**. There are 4 possible signals: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

##### Command variations

<table border="1" id="bkmrk-signal-type-availabl" style="border-collapse: collapse; width: 100%; height: 87px;"><tbody><tr style="height: 29px;"><td class="align-center" style="width: 33.3333%; height: 29px;">Signal Type</td><td class="align-center" style="width: 33.3333%; height: 29px;">Available Command Variation</td><td class="align-center" style="width: 33.3333%; height: 29px;">Default Command Variation</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Binary Output Command (Group12)</td><td style="width: 33.3333%; height: 29px;">0, 1</td><td class="align-center" style="width: 33.3333%; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Analog Output Command (Group41)</td><td style="width: 33.3333%; height: 29px;">0, 1, 2, 3, 4</td><td class="align-center" style="width: 33.3333%; height: 29px;">1</td></tr></tbody></table>

##### Static and Event variations

<table border="1" id="bkmrk-signal-type-availabl-0" style="border-collapse: collapse; width: 100%; height: 291px;"><tbody><tr style="height: 29px;"><td class="align-center" style="width: 33.3333%; height: 29px;">Signal Type</td><td class="align-center" style="width: 40.1234%; height: 29px;">Available Variations</td><td class="align-center" style="width: 26.5432%; height: 29px;">Default Variations</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Binary</td><td style="width: 40.1234%; height: 29px;">Static variation (Group1) 1, 2  
Event variation (Group2) 1, 2, 3</td><td style="width: 26.5432%; height: 29px;">Static variation 2  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Double Binary</td><td style="width: 40.1234%; height: 29px;">Static variation (Group3) 2  
Event variation (Group4) 1, 2, 3</td><td style="width: 26.5432%; height: 29px;">Static variation 2  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Binary Output Status</td><td style="width: 40.1234%; height: 29px;">Static variation (Group10) 2  
Event variation (Group11) 1, 2</td><td style="width: 26.5432%; height: 29px;">Static variation 2  
Event variation 1</td></tr><tr style="height: 30px;"><td style="width: 33.3333%; height: 30px;">Counter</td><td style="width: 40.1234%; height: 30px;">Static variation (Group20) 1, 2, 5, 6  
Event variation (Group22) 1, 2, 5, 6</td><td style="width: 26.5432%; height: 30px;">Static variation 1  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Frozen Counter</td><td style="width: 40.1234%; height: 29px;">Static variations (Group21) 1, 2, 5, 6, 9,10  
Event variation (Group23) 1, 2, 5, 6</td><td style="width: 26.5432%; height: 29px;">Static variation 1  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Analog</td><td style="width: 40.1234%; height: 29px;">Static variation (Group30) 1, 2, 3, 4, 5, 6  
Event variation (Group32) 1, 2, 3, 4, 5, 6, 7, 8</td><td style="width: 26.5432%; height: 29px;">Static variation 1  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Analog Output Status</td><td style="width: 40.1234%; height: 29px;">Static variation (Group40) 1, 2, 3, 4  
Event variation (Group42) 1, 2, 3, 4, 5, 6, 7, 8</td><td style="width: 26.5432%; height: 29px;">Static variation 1  
Event variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Time and Interval</td><td style="width: 40.1234%; height: 29px;">Static variation (Group50) 1</td><td style="width: 26.5432%; height: 29px;">Static variation 1</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Octet String</td><td style="width: 40.1234%; height: 29px;">Static variation (Group110) 0  
Event variation (Group111) 0</td><td style="width: 26.5432%; height: 29px;">Static variation 0  
Event variation 0</td></tr></tbody></table>

#### Debugging the DNP3 Slave service

If configuration for DNP3 devices is set up, handler for protocol will start automatically. If configuration is missing or contains errors, protocol will not start. It is done intentionally decrease unnecessary memory usage.

DNP3 protocol runs a service called **dnp3-­slave** . If DNP3 does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from command line interface and find out why link is not functioning properly. To launch a debugging session, a user should stop **dnp3-­slave** process and run **dnp3-slave** command with respective flags as in the table given below.

Procedure for DNP3 Master protocol service debugging:

- **Step 1**: Service must be stopped by entering the following command into the wcclite:  
    **/etc/init.d/dnp3-­slave stop**
- **Step 2**: After service is stopped it must be started with the preferred configuration file (JSON files found in /etc/ folder) and a debug level 7: **dnp3­-slave ­-c /etc/dnp3-­slave/dnp3­slave.json ­-d7** Additional output forming options described in the table below.
- **Step 3**: Once the problem is diagnosed normal operations can be resumed with the following command: **/etc/init.d/dnp3-­slave start**

dnp3­-slave command line debugging options

<table border="1" class="align-center" id="bkmrk-option%C2%A0-description--0" style="border-collapse: collapse; width: 49.3298%; height: 328px;"><tbody><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">Option </td><td style="width: 64.9456%; height: 29px;">Description</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">­-h \[ –help \] </td><td style="width: 64.9456%; height: 29px;">Display help information</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">­-V \[ –version \] </td><td style="width: 64.9456%; height: 29px;">Show version</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">-p \[ –port \]</td><td style="width: 64.9456%; height: 29px;">­Show output for one port only</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">­-d &lt;debug level&gt;</td><td style="width: 64.9456%; height: 29px;">Set debugging level</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">-­c \[ –config \] </td><td style="width: 64.9456%; height: 29px;">Config path</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">-­a \[ –app \]</td><td style="width: 64.9456%; height: 29px;">Show application layer data</td></tr><tr style="height: 21px;"><td style="width: 35.0544%; height: 21px;">–l \[ –link \] </td><td style="width: 64.9456%; height: 21px;">Show link layer data</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">–t \[ –transport \] </td><td style="width: 64.9456%; height: 29px;">Show transport layer data</td></tr><tr style="height: 29px;"><td style="width: 35.0544%; height: 29px;">-­r \[ –redis \] </td><td style="width: 64.9456%; height: 29px;">Show Redis messages</td></tr><tr style="height: 46px;"><td style="width: 35.0544%; height: 46px;">-­R \[ –readyfile \] </td><td style="width: 64.9456%; height: 46px;">Ready notification file</td></tr></tbody></table>

# 13 Modbus



# 13.1 Introduction

Modbus is a communication protocol for use with its programmable logic controllers (PLCs). Modbus has become a de facto standard communication protocol and is now a commonly available means of connecting industrial electronic devices. It was developed for industrial applications, is relatively easy to deploy and maintain compared to other standards, and places few restrictions other than size on the format of the data to be transmitted.

Modbus enables communication among many devices connected to the same network, for example, a system that measures temperature and humidity and communicates the results to a computer. Modbus is often used to connect a supervisory computer with a remote terminal unit (RTU) in supervisory control and data acquisition (SCADA) systems. Many of the data types are named from industry usage of Ladder logic and its use in driving relays: a single-bit physical output is called a coil, and a single-bit physical input is called a discrete input or a contact.

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk-" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>WCC Lite supports both Modbus Master and Slave protocols. One can select between transmission over TCP/IP or serial connection (RS-485/RS232). Bytes to transmit can either be encoded according to both RTU and ASCII parts of standard.

# 13.2 Modbus Master

Modbus communication contains a single Master and may include more than 1, but not more than 247 devices. To gather data from peripheral devices, master device request a cluster of slave devices for data. If any device understand that this message is addressed for it – it replies with data. As no timestamp is sent along with data, having recent data requires frequent polling. WCC Lite can be configured to acquire data periodically in custom-defined intervals.

#### Configuring datapoints

To use Modbus Master in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in - Devices and Signals

##### Modbus Master parameters for Devices tab

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 1584.12px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 18.9076%; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 8.40336%; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 25.9516%; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 12.8522%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 11.8636%; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 21.997%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 6.4261%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 6.4261%; height: 30.0938px;">RTU/ASCII</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Min</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Max</th></tr><tr style="height: 35.3906px;"><td style="width: 18.9076%; height: 35.3906px;">name

</td><td style="width: 8.40336%; height: 35.3906px;">string</td><td style="width: 25.9516%; height: 35.3906px;">User-friendly name for a device

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 35.3906px;">  
</td><td style="width: 10.9985%; height: 35.3906px;">  
</td><td style="width: 10.9985%; height: 35.3906px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 18.9076%; height: 35.3906px;">description

</td><td style="width: 8.40336%; height: 35.3906px;">string</td><td style="width: 25.9516%; height: 35.3906px;">Description of a device

</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 11.8636%; height: 35.3906px;">  
</td><td style="width: 10.9985%; height: 35.3906px;">  
</td><td style="width: 10.9985%; height: 35.3906px;">  
</td></tr><tr style="height: 57.7812px;"><td style="width: 18.9076%; height: 57.7812px;">device\_alias

</td><td style="width: 8.40336%; height: 57.7812px;">string</td><td style="width: 25.9516%; height: 57.7812px;">Alphanumeric string to identify a device

</td><td style="width: 6.4261%; height: 57.7812px;">Yes</td><td style="width: 6.4261%; height: 57.7812px;">Yes</td><td style="width: 11.8636%; height: 57.7812px;">  
</td><td style="width: 10.9985%; height: 57.7812px;">  
</td><td style="width: 10.9985%; height: 57.7812px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 18.9076%; height: 35.3906px;">enable</td><td style="width: 8.40336%; height: 35.3906px;">boolean</td><td style="width: 25.9516%; height: 35.3906px;">Enabling/disabling of a device

</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 11.8636%; height: 35.3906px;">1</td><td style="width: 10.9985%; height: 35.3906px;">0</td><td style="width: 10.9985%; height: 35.3906px;">1</td></tr><tr style="height: 49.5938px;"><td style="width: 18.9076%; height: 49.5938px;">protocol</td><td style="width: 8.40336%; height: 49.5938px;">string</td><td style="width: 25.9516%; height: 49.5938px;">Protocol to be used

</td><td style="width: 6.4261%; height: 49.5938px;">Yes</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 49.5938px;">  
</td><td colspan="2" style="width: 21.997%; height: 49.5938px;">Modbus RTU, Modbus TCP</td></tr><tr style="height: 29.7969px;"><td style="width: 18.9076%; height: 29.7969px;">ip</td><td style="width: 8.40336%; height: 29.7969px;">string</td><td style="width: 25.9516%; height: 29.7969px;">IP address of TCP slave device</td><td style="width: 6.4261%; height: 29.7969px;">Yes</td><td style="width: 6.4261%; height: 29.7969px;">-</td><td style="width: 11.8636%; height: 29.7969px;">  
</td><td style="width: 10.9985%; height: 29.7969px;">  
</td><td style="width: 10.9985%; height: 35.3906px;">  
</td></tr><tr style="height: 57px;"><td style="width: 18.9076%; height: 57px;">port</td><td style="width: 8.40336%; height: 57px;">integer</td><td style="width: 25.9516%; height: 57px;">TCP communication port

</td><td style="width: 6.4261%; height: 57px;">Yes

</td><td style="width: 6.4261%; height: 57px;">-

</td><td style="width: 11.8636%; height: 57px;">502

</td><td style="width: 10.9985%; height: 57px;"></td><td style="width: 10.9985%; height: 35.3906px;">  
</td></tr><tr style="height: 80.1719px;"><td style="width: 18.9076%; height: 80.1719px;">bind\_address</td><td style="width: 8.40336%; height: 80.1719px;">string</td><td style="width: 25.9516%; height: 80.1719px;">IP address of network adapter used to connect to slave device

(Default: ”0.0.0.0”)

</td><td style="width: 6.4261%; height: 80.1719px;">No</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 11.8636%; height: 80.1719px;">0.0.0.0</td><td style="width: 10.9985%; height: 80.1719px;">  
</td><td style="width: 10.9985%; height: 80.1719px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 18.9076%; height: 29.7969px;"> id</td><td style="width: 8.40336%; height: 29.7969px;">integer</td><td style="width: 25.9516%; height: 29.7969px;">Modbus Slave ID</td><td style="width: 6.4261%; height: 29.7969px;">Yes</td><td style="width: 6.4261%; height: 29.7969px;">Yes</td><td style="width: 11.8636%; height: 29.7969px;">  
</td><td style="width: 10.9985%; height: 29.7969px;">  
</td><td style="width: 10.9985%; height: 35.3906px;">  
</td></tr><tr style="height: 83.1875px;"><td style="width: 18.9076%; height: 83.1875px;">mode</td><td style="width: 8.40336%; height: 83.1875px;">string</td><td style="width: 25.9516%; height: 83.1875px;">Choosing between RTU (”rtu”), ASCII  
(”ascii”) and TCP(”tcp”) modes. ASCII  
is the same as RTU, but with ASCII  
symbols.</td><td style="width: 6.4261%; height: 83.1875px;">No</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 11.8636%; height: 83.1875px;">TCP (for TCP)

RTU (for Serial)

</td><td colspan="2" style="width: 21.997%; height: 83.1875px;">rtu, ascii, tcp</td></tr><tr style="height: 35.3906px;"><td style="width: 18.9076%; height: 35.3906px;">timeout\_ms</td><td style="width: 8.40336%; height: 35.3906px;">integer</td><td style="width: 25.9516%; height: 35.3906px;">Response timeout in milliseconds

</td><td style="width: 6.4261%; height: 35.3906px;">Yes

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 35.3906px;">10000

</td><td style="width: 10.9985%; height: 35.3906px;"></td><td style="width: 10.9985%; height: 35.3906px;"></td></tr><tr style="height: 57.7812px;"><td style="width: 18.9076%; height: 57.7812px;">device</td><td style="width: 8.40336%; height: 57.7812px;">string

</td><td style="width: 25.9516%; height: 57.7812px;">Communication port (”PORT1”/”PORT2”)

</td><td style="width: 6.4261%; height: 57.7812px;">-

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 57.7812px;"></td><td style="width: 10.9985%; height: 57.7812px;">PORT1

</td><td style="width: 10.9985%; height: 57.7812px;">PORT2

</td></tr><tr style="height: 80.1719px;"><td style="width: 18.9076%; height: 80.1719px;">baudrate</td><td style="width: 8.40336%; height: 80.1719px;">integer</td><td style="width: 25.9516%; height: 80.1719px;">Communication speed, baud/s

</td><td style="width: 6.4261%; height: 80.1719px;">-

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 80.1719px;">9600

</td><td colspan="2" style="width: 21.997%; height: 80.1719px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

</td></tr><tr style="height: 57.7812px;"><td style="width: 18.9076%; height: 57.7812px;">databits</td><td style="width: 8.40336%; height: 57.7812px;">integer</td><td style="width: 25.9516%; height: 57.7812px;">Data bit count for communication

</td><td style="width: 6.4261%; height: 57.7812px;">-

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 57.7812px;">8

</td><td style="width: 10.9985%; height: 57.7812px;">6

</td><td style="width: 10.9985%; height: 57.7812px;">9

</td></tr><tr style="height: 57.7812px;"><td style="width: 18.9076%; height: 57.7812px;">stopbits</td><td style="width: 8.40336%; height: 57.7812px;">integer</td><td style="width: 25.9516%; height: 57.7812px;">Stop bit count for communication

</td><td style="width: 6.4261%; height: 57.7812px;">-

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 57.7812px;">1

</td><td style="width: 10.9985%; height: 57.7812px;">1

</td><td style="width: 10.9985%; height: 57.7812px;">2

</td></tr><tr style="height: 57.7812px;"><td style="width: 18.9076%; height: 57.7812px;">parity</td><td style="width: 8.40336%; height: 57.7812px;">string

</td><td style="width: 25.9516%; height: 57.7812px;">Communication parity option

</td><td style="width: 6.4261%; height: 57.7812px;">-

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 57.7812px;">none

</td><td colspan="2" style="width: 21.997%; height: 57.7812px;">none, even, odd

</td></tr><tr style="height: 102.562px;"><td style="width: 18.9076%; height: 102.562px;">flowcontrol</td><td style="width: 8.40336%; height: 102.562px;">string

</td><td style="width: 25.9516%; height: 102.562px;">Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued

</td><td style="width: 6.4261%; height: 102.562px;">-

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 102.562px;">none

</td><td colspan="2" style="width: 21.997%; height: 102.562px;">none

</td></tr><tr style="height: 124.953px;"><td style="width: 18.9076%; height: 124.953px;">scan\_rate\_ms</td><td style="width: 8.40336%; height: 124.953px;">integer</td><td style="width: 25.9516%; height: 124.953px;">If provided and positive - all jobs will have similar scan rate - all reads and writes will be executed within this timeframe (parameter scan\_rate\_ms in Signals tab will be ignored)

</td><td style="width: 6.4261%; height: 124.953px;">Yes</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 124.953px;">300</td><td style="width: 10.9985%; height: 124.953px;">  
</td><td style="width: 10.9985%; height: 124.953px;">  
</td></tr><tr style="height: 102.562px;"><td style="width: 18.9076%; height: 102.562px;">retry\_count</td><td style="width: 8.40336%; height: 102.562px;">integer</td><td style="width: 25.9516%; height: 102.562px;">Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued

</td><td style="width: 6.4261%; height: 102.562px;">No</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 11.8636%; height: 102.562px;">3</td><td style="width: 10.9985%; height: 102.562px;">  
</td><td style="width: 10.9985%; height: 102.562px;">  
</td></tr><tr style="height: 57.7812px;"><td style="width: 18.9076%; height: 57.7812px;">serial\_delay</td><td style="width: 8.40336%; height: 57.7812px;">integer</td><td style="width: 25.9516%; height: 57.7812px;">RS485 delay between read and write operations in milliseconds

</td><td style="width: 6.4261%; height: 57.7812px;">-

</td><td style="width: 6.4261%; height: 35.3906px;">Yes</td><td style="width: 11.8636%; height: 57.7812px;">50

</td><td style="width: 10.9985%; height: 57.7812px;"></td><td style="width: 10.9985%; height: 57.7812px;"></td></tr><tr style="height: 57.7812px;"><td style="width: 18.9076%; height: 57.7812px;">keep\_alive\_timeout

</td><td style="width: 8.40336%; height: 57.7812px;">integer</td><td style="width: 25.9516%; height: 57.7812px;">Time interval for sending a keep alive packet (in milliseconds)

</td><td style="width: 6.4261%; height: 57.7812px;">No</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 11.8636%; height: 57.7812px;">60</td><td style="width: 10.9985%; height: 57.7812px;">  
</td><td style="width: 10.9985%; height: 57.7812px;">  
</td></tr><tr style="height: 80.1719px;"><td style="width: 18.9076%; height: 80.1719px;">modbus\_multi\_write

</td><td style="width: 8.40336%; height: 80.1719px;">boolean</td><td style="width: 25.9516%; height: 80.1719px;">Use 15/16 functions to write 1 register/coil

(Default: 0)

</td><td style="width: 6.4261%; height: 80.1719px;">No</td><td style="width: 6.4261%; height: 35.3906px;">No</td><td style="width: 11.8636%; height: 80.1719px;">0</td><td style="width: 10.9985%; height: 80.1719px;">0</td><td style="width: 10.9985%; height: 80.1719px;">1</td></tr><tr style="height: 102.562px;"><td style="width: 18.9076%; height: 102.562px;">comm\_restart\_delay

</td><td style="width: 8.40336%; height: 102.562px;">integer</td><td style="width: 25.9516%; height: 102.562px;">Time delay between disconnecting from slave device and restarting connection (in milliseconds)

(Default: 500)

</td><td style="width: 6.4261%; height: 102.562px;">No

</td><td style="width: 6.4261%; height: 35.3906px;">-</td><td style="width: 11.8636%; height: 102.562px;">500

</td><td style="width: 10.9985%; height: 102.562px;"></td><td style="width: 10.9985%; height: 102.562px;"></td></tr><tr style="height: 35.3906px;"><td style="width: 18.9076%; height: 35.3906px;">update

</td><td style="width: 8.40336%; height: 35.3906px;">boolean</td><td style="width: 25.9516%; height: 35.3906px;">Enable to keep updating the tags even if they have the same value.

</td><td style="width: 6.4261%; height: 35.3906px;">No

</td><td style="width: 6.4261%; height: 35.3906px;">No

</td><td style="width: 11.8636%; height: 35.3906px;">0

</td><td style="width: 10.9985%; height: 35.3906px;">0

</td><td style="width: 10.9985%; height: 35.3906px;">1

</td></tr></tbody></table>

##### Modbus Master parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr-0" style="border-collapse: collapse; width: 100%; height: 158.12px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 18.1661%; height: 30.0938px;">**Parameter**  
  
</th><th rowspan="2" style="width: 9.26719%; height: 30.0938px;">**Type**  
  
</th><th rowspan="2" style="width: 25.8292%; height: 30.0938px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 12.8522%; height: 30.0938px;">**Required**  
  
</th><th rowspan="2" style="width: 11.8636%; height: 30.0938px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 21.997%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 6.4261%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 6.4261%; height: 30.0938px;">RTU/ASCII</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Min</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Max</th></tr><tr style="height: 35px;"><td style="width: 18.1661%; height: 35px;">signal\_name

</td><td style="width: 9.26719%; height: 35px;">string</td><td style="width: 25.8292%; height: 35px;">User-friendly signal name

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 18.1661%; height: 35px;">device\_alias

</td><td style="width: 9.26719%; height: 35px;">string</td><td style="width: 25.8292%; height: 35px;">Alphanumeric string to identify a device

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 18.1661%; height: 35px;">signal\_alias

</td><td style="width: 9.26719%; height: 35px;">string</td><td style="width: 25.8292%; height: 35px;">Unique alphanumeric name of the signal to be Yes used

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 18.1661%; height: 29px;">enable</td><td style="width: 9.26719%; height: 29px;">boolean</td><td style="width: 25.8292%; height: 29px;">Enabling/disabling of an individual signal

</td><td style="width: 6.4261%; height: 29px;">No</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 11.8636%; height: 29px;">1</td><td style="width: 10.9985%; height: 29px;">0</td><td style="width: 10.9985%; height: 29px;">1</td></tr><tr style="height: 35px;"><td style="width: 18.1661%; height: 35px;">job\_todo

</td><td style="width: 9.26719%; height: 35px;">string</td><td style="width: 25.8292%; height: 35px;">Request to send according to Modbus specification without device address and checksum. This field can be identical on several tags to fetch them in single request

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 102px;"><td style="width: 18.1661%; height: 102px;">tag\_job\_todo

</td><td style="width: 9.26719%; height: 102px;">string</td><td style="width: 25.8292%; height: 102px;">Similar format to job\_todo field. Address and length must be a subset of job field. Defines the individual tag’s register(s) or coil(s). Can be described in HEX or DEC formats

</td><td style="width: 6.4261%; height: 102px;">Yes</td><td style="width: 6.4261%; height: 102px;">Yes</td><td style="width: 11.8636%; height: 102px;">  
</td><td style="width: 10.9985%; height: 102px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 18.1661%; height: 35px;">number\_type

</td><td style="width: 9.26719%; height: 35px;">string</td><td style="width: 25.8292%; height: 35px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 18.1661%; height: 35px;">log

</td><td style="width: 9.26719%; height: 35px;">integer</td><td style="width: 25.8292%; height: 35px;">1 enables logging to Events log, 0 disables

</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 11.8636%; height: 35px;">0</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 18.1661%; height: 35px;">pulse\_short\_time\_ms

</td><td style="width: 9.26719%; height: 35px;">integer</td><td style="width: 25.8292%; height: 35px;">Time interval for short output pulse to stay active

</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 11.8636%; height: 35px;">0</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 18.1661%; height: 35px;">pulse\_long\_time\_ms

</td><td style="width: 9.26719%; height: 35px;">integer</td><td style="width: 25.8292%; height: 35px;">Time interval for long output pulse to stay active

</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 11.8636%; height: 35px;">0</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr></tbody></table>

##### Device status signals

Modbus Master has an additional signal which can be configured to show communication status. It is used to indicate if the slave device has disconnected from master (WCC Lite). To configure such signal for Modbus protocol, job\_todo and tag\_job\_todo fields with string values are required. For Modbus master required parameters for status signal will be: **signal\_name** **device\_alias, signal\_alias, number\_type, job\_todo** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

Different device vendors can have different implementations of a Modbus protocol stack. A register table can be a one of the primary differences. WCC Lite Modbus Master transmits the most significant word (byte) first, however, devices from some vendors might require transmitting the least significant word (byte) first. If that is the case, make sure to switch bytes as needed. To find out more about setting a correct number format, one should consult a section [`number_type`](https://wiki.elseta.com/link/859#bkmrk-number_type-field).

Modbus job or tag (as a task to be completed) can be built in two different formats - user can select a more convenient way for him:

- hexadecimal format with every single byte separated by | symbol. Device address, bytes containing output information and CRC (LRC) bytes should be excluded from the message;
- decimal format containing function number, first address and address count, separated by ; symbol. All other information should be excluded from the message;

`job_todo` can group several `tag_job_todo`’s. That way one Modbus message can be used to extract several tags. Grouping is accomplished dynamically meaning that if several identical jobs are found, their tags are grouped automatically.

#### Debugging a Modbus Master application

If configuration for Modbus Master is set up, handler for protocol will start automatically. If configuration is missing or contains errors, protocol will not start. It is done intentionally to decrease unnecessary memory usage.

Modbus Master command line debugging options

`modbus-master `

```
-h [ –help ] Display help information 
-V [ –version ] Show version
-d<debug level> Set debugging level 
-c [ –config ] Config path
-r [ –raw ] Show raw telegram data
-f [ –frame ] Show frame data
-s [ –serial ] Show serial port data 
–tcp Show tcp packets
–ascii Show ASCII messages
–rtu Show RTU messages
-e [ –redis ] Show redis debug information 
-R [ –readyfile ] Ready notification file
```

If Modbus Master does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from command line interface and find out why link is not functioning properly. To launch a debugging session, a user should stop modbus-master process and run modbus-master command with respective flags as shown above.

# 13.3 Modbus Slave

WCC Lite can act as one (or several) of slave devices in a communication line. This can be used to transmit data to SCADA systems or other RTU devices. It can reply to a messages from Modbus Master with matching device and register addresses.

#### Configuring datapoints

To use Modbus Slave in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in - Devices and Signals

<p class="callout warning">If TCP/IP is used as a trasmission medium, only devices with IPs predefined in host column are allowed to connect. All other connections are rejected</p>

##### Modbus Slave parameters for Devices tab

<table border="1" id="bkmrk-parameter-descr" style="border-collapse: collapse; width: 726px; height: 484px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 140.8px; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 69.7125px; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 175.95px; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 102.4px; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 76.8px; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 159.538px; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 51.2px; height: 30.0938px;">TCP</th><th class="align-center" style="width: 51.2px; height: 30.0938px;">RTU/ASCII</th><th class="align-center" style="width: 79.7625px; height: 30.0938px;">Min</th><th class="align-center" style="width: 79.775px; height: 30.0938px;">Max</th></tr><tr style="height: 35px;"><td style="width: 140.8px; height: 35px;">name

</td><td style="width: 69.7125px; height: 35px;">string</td><td style="width: 175.95px; height: 35px;">User-friendly name for a device

</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 76.8px; height: 35px;">  
</td><td style="width: 79.7625px; height: 35px;">  
</td><td style="width: 79.775px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 140.8px; height: 35px;">description

</td><td style="width: 69.7125px; height: 35px;">string</td><td style="width: 175.95px; height: 35px;">Description of a device

</td><td style="width: 51.2px; height: 35px;">No</td><td style="width: 51.2px; height: 35px;">No</td><td style="width: 76.8px; height: 35px;">  
</td><td style="width: 79.7625px; height: 35px;">  
</td><td style="width: 79.775px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 140.8px; height: 35px;">device\_alias

</td><td style="width: 69.7125px; height: 35px;">string</td><td style="width: 175.95px; height: 35px;">Alphanumeric string to identify a device

</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 76.8px; height: 35px;"><div><div>unknown</div></div></td><td style="width: 79.7625px; height: 35px;">  
</td><td style="width: 79.775px; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 29px;">enable</td><td style="width: 69.7125px; height: 29px;">boolean</td><td style="width: 175.95px; height: 29px;">Enabling/disabling of a device

</td><td style="width: 51.2px; height: 29px;">No</td><td style="width: 51.2px; height: 35px;">No</td><td style="width: 76.8px; height: 29px;">1</td><td style="width: 79.7625px; height: 29px;">0</td><td style="width: 79.775px; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 30px;">protocol</td><td style="width: 69.7125px; height: 30px;">string</td><td style="width: 175.95px; height: 30px;">Protocol to be used

</td><td style="width: 51.2px; height: 30px;">Yes</td><td style="width: 51.2px; height: 30px;">Yes</td><td style="width: 76.8px; height: 35px;">  
</td><td colspan="2" style="width: 159.538px; height: 30px;">Modbus serial Slave, Modbus TCP Slave</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 29px;">host</td><td style="width: 69.7125px; height: 29px;">string</td><td style="width: 175.95px; height: 29px;">Space separated host IP addresses of  
master device</td><td style="width: 51.2px; height: 29px;">Yes</td><td style="width: 51.2px; height: 29px;">-</td><td style="width: 76.8px; height: 29px;">  
</td><td style="width: 79.7625px; height: 29px;">  
</td><td style="width: 79.775px; height: 35px;">  
</td></tr><tr style="height: 57px;"><td style="width: 140.8px; height: 57px;">port</td><td style="width: 69.7125px; height: 57px;">integer</td><td style="width: 175.95px; height: 57px;">TCP port to listen for incoming connections

</td><td style="width: 51.2px; height: 57px;">Yes

</td><td style="width: 51.2px; height: 57px;">-

</td><td style="width: 76.8px; height: 57px;"></td><td style="width: 79.7625px; height: 57px;"></td><td style="width: 79.775px; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 29px;">bind\_address</td><td style="width: 69.7125px; height: 29px;">string</td><td style="width: 175.95px; height: 29px;">IP address of network adapter used to connect to slave device

(Default: ”0.0.0.0”)

</td><td style="width: 51.2px; height: 29px;">No</td><td style="width: 51.2px; height: 35px;">No</td><td style="width: 76.8px; height: 29px;">0.0.0.0</td><td style="width: 79.7625px; height: 29px;">  
</td><td style="width: 79.775px; height: 29px;">  
</td></tr><tr style="height: 35px;"><td style="width: 140.8px; height: 35px;">keep\_alive\_timeout

</td><td style="width: 69.7125px; height: 35px;">integer</td><td style="width: 175.95px; height: 35px;">Minimum time a connection can be idle without being closed in milliseconds

</td><td style="width: 51.2px; height: 35px;">No</td><td style="width: 51.2px; height: 35px;">No</td><td style="width: 76.8px; height: 35px;">60</td><td style="width: 79.7625px; height: 35px;">  
</td><td style="width: 79.775px; height: 35px;">  
</td></tr><tr style="height: 82px;"><td style="width: 140.8px; height: 82px;">mode</td><td style="width: 69.7125px; height: 82px;">string</td><td style="width: 175.95px; height: 82px;">Choosing between RTU (”rtu”), ASCII  
(”ascii”) and TCP(”tcp”) modes. ASCII  
is the same as RTU, but with ASCII  
symbols.</td><td style="width: 51.2px; height: 82px;">No</td><td style="width: 51.2px; height: 35px;">No</td><td style="width: 76.8px; height: 82px;">TCP (for TCP)

RTU (for Serial)

</td><td colspan="2" style="width: 159.538px; height: 82px;">rtu, ascii, tcp</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 10px;">device</td><td style="width: 69.7125px; height: 10px;">string

</td><td style="width: 175.95px; height: 10px;">Communication port (”PORT1”/”PORT2”)

</td><td style="width: 51.2px; height: 10px;">-

</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 76.8px; height: 10px;"></td><td style="width: 79.7625px; height: 10px;">PORT1

</td><td style="width: 79.775px; height: 10px;">PORT2

</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 29px;">baudrate</td><td style="width: 69.7125px; height: 29px;">integer</td><td style="width: 175.95px; height: 29px;">Communication speed, baud/s

</td><td style="width: 51.2px; height: 29px;">-

</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 76.8px; height: 29px;">9600

</td><td colspan="2" style="width: 159.538px; height: 29px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 29px;">databits</td><td style="width: 69.7125px; height: 29px;">integer</td><td style="width: 175.95px; height: 29px;">Data bit count for communication

</td><td style="width: 51.2px; height: 29px;">-

</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 76.8px; height: 29px;">8

</td><td style="width: 79.7625px; height: 29px;">6

</td><td style="width: 79.775px; height: 29px;">9

</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 29px;">stopbits</td><td style="width: 69.7125px; height: 29px;">integer</td><td style="width: 175.95px; height: 29px;">Stop bit count for communication

</td><td style="width: 51.2px; height: 29px;">-

</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 76.8px; height: 29px;">1

</td><td style="width: 79.7625px; height: 29px;">1

</td><td style="width: 79.775px; height: 29px;">2

</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 29px;">parity</td><td style="width: 69.7125px; height: 29px;">string

</td><td style="width: 175.95px; height: 29px;">Communication parity option

</td><td style="width: 51.2px; height: 29px;">-

</td><td style="width: 51.2px; height: 35px;">Yes</td><td style="width: 76.8px; height: 29px;">none

</td><td colspan="2" style="width: 159.538px; height: 29px;">none, even, odd

</td></tr><tr style="height: 29px;"><td style="width: 140.8px; height: 29px;">flowcontrol</td><td style="width: 69.7125px; height: 29px;">string

</td><td style="width: 175.95px; height: 29px;">Communication device’s flow control  
option.

</td><td style="width: 51.2px; height: 29px;">-</td><td style="width: 51.2px; height: 35px;">No</td><td style="width: 76.8px; height: 29px;">none

</td><td colspan="2" style="width: 159.538px; height: 29px;">none

</td></tr></tbody></table>

##### Modbus Slave parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 726px; height: 484px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 90.8px; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 70.7125px; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 224.962px; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 104.4px; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 74.8px; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 159.525px; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 44.2px; height: 30.0938px;">TCP</th><th class="align-center" style="width: 60.2px; height: 30.0938px;">RTU/ASCII</th><th class="align-center" style="width: 79.7375px; height: 30.0938px;">Min</th><th class="align-center" style="width: 79.7875px; height: 30.0938px;">Max</th></tr><tr style="height: 35px;"><td style="width: 90.8px; height: 35px;">signal\_name

</td><td style="width: 70.7125px; height: 35px;">string</td><td style="width: 224.962px; height: 35px;">User-friendly signal name

</td><td style="width: 44.2px; height: 35px;">Yes</td><td style="width: 60.2px; height: 35px;">Yes</td><td style="width: 74.8px; height: 35px;">  
</td><td style="width: 79.7375px; height: 35px;">  
</td><td style="width: 79.7875px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 90.8px; height: 35px;">device\_alias

</td><td style="width: 70.7125px; height: 35px;">string</td><td style="width: 224.962px; height: 35px;">Alphanumeric string to identify a device

</td><td style="width: 44.2px; height: 35px;">Yes</td><td style="width: 60.2px; height: 35px;">Yes</td><td style="width: 74.8px; height: 35px;">  
</td><td style="width: 79.7375px; height: 35px;">  
</td><td style="width: 79.7875px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 90.8px; height: 35px;">signal\_alias

</td><td style="width: 70.7125px; height: 35px;">string</td><td style="width: 224.962px; height: 35px;">Unique alphanumeric name of the signal to be Yes used

</td><td style="width: 44.2px; height: 35px;">Yes</td><td style="width: 60.2px; height: 35px;">Yes</td><td style="width: 74.8px; height: 35px;">  
</td><td style="width: 79.7375px; height: 35px;">  
</td><td style="width: 79.7875px; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 90.8px; height: 29px;">enable</td><td style="width: 70.7125px; height: 29px;">boolean</td><td style="width: 224.962px; height: 29px;">Enabling/disabling an individual signal

</td><td style="width: 44.2px; height: 29px;">No</td><td style="width: 60.2px; height: 35px;">No</td><td style="width: 74.8px; height: 29px;">1</td><td style="width: 79.7375px; height: 29px;">0</td><td style="width: 79.7875px; height: 29px;">1</td></tr><tr style="height: 35px;"><td style="width: 90.8px; height: 35px;">number\_type

</td><td style="width: 70.7125px; height: 35px;">string</td><td style="width: 224.962px; height: 35px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.). This defines the size that will be read.

</td><td style="width: 44.2px; height: 35px;">Yes</td><td style="width: 60.2px; height: 35px;">Yes</td><td style="width: 74.8px; height: 35px;">  
</td><td style="width: 79.7375px; height: 35px;">  
</td><td style="width: 79.7875px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 90.8px; height: 35px;">log

</td><td style="width: 70.7125px; height: 35px;">integer</td><td style="width: 224.962px; height: 35px;">Size of this signal’s log in the Event log.

</td><td style="width: 44.2px; height: 35px;">No</td><td style="width: 60.2px; height: 35px;">No</td><td style="width: 74.8px; height: 35px;">0</td><td style="width: 79.7375px; height: 35px;">  
</td><td style="width: 79.7875px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 90.8px; height: 35px;">slave\_id</td><td style="width: 70.7125px; height: 35px;">integer</td><td style="width: 224.962px; height: 35px;">Address of a slave device</td><td style="width: 44.2px; height: 35px;">Yes</td><td style="width: 60.2px; height: 35px;">Yes</td><td style="width: 74.8px; height: 35px;">  
</td><td style="width: 79.7375px; height: 35px;">  
</td><td style="width: 79.7875px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 90.8px; height: 35px;">function</td><td style="width: 70.7125px; height: 35px;">integer</td><td style="width: 224.962px; height: 35px;">Function number</td><td style="width: 44.2px; height: 35px;">Yes</td><td style="width: 60.2px; height: 35px;">Yes</td><td style="width: 74.8px; height: 35px;">  
</td><td style="width: 79.7375px; height: 35px;">  
</td><td style="width: 79.7875px; height: 35px;">  
</td></tr><tr><td style="width: 90.8px;">register\_address</td><td style="width: 70.7125px;">integer</td><td style="width: 224.962px;">Register address</td><td style="width: 44.2px;">Yes</td><td style="width: 60.2px;">Yes</td><td style="width: 74.8px;">  
</td><td style="width: 79.7375px;">  
</td><td style="width: 79.7875px; height: 35px;">  
</td></tr></tbody></table>

##### Device status signals

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk-" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>Modbus slave has an additional signal which can be configured to show communication status. It is used to indicate if the master device has disconnected from slave (WCC Lite). To configure such signal for Modbus protocol, job\_todo and tag\_job\_todo fields with string values are required. For Modbus slave required parameters for status signal will be: **signal\_name** **device\_alias, signal\_alias, number\_type, slave\_id, function**, **register\_address, job\_todo** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

#### Mapping values to registers

Internally stored values aren’t organised in a register-like order, therefore mapping should be done by the user. This mapping includes setting an address of the device WCC Lite is simulating as well as function number, register number and how much 16-bit registers are used to store a value. These values should be set in `common_address`, `function`, `info_address` and `size` columns respectively in the Excel configuration.

To find out how many register should be used for storing a values, how values can have their values swapped, a user should consult a section <span style="color: #3598db;">`<a href="https://wiki.elseta.com/books/manual/page/182-optional-parameters-for-signals#bkmrk-number_type-field" style="color: #3598db;">number_type</a>`</span>.

<p class="callout warning">If a Modbus master device requests a data from a register that is mapped but doesn’t yet have initial value, ILLEGAL DATA ADDRESS error code will be returned. The same error code is returned if a requested size of value is bigger that defined or if register is not configured at all.</p>

#### Debugging a Modbus Slave application

If configuration for Modbus Slave is set up, handler for protocol will start automatically. If configuration is missing or contains errors, protocol will not start. It is done intentionally to decrease unnecessary memory usage.

Modbus Slave command line debugging options

`modbus-slave`

```
-h [ –help ] Display help information 
-V [ –version ] Show version
-d<debug level> Set debugging level 
-c [ –config ] Config path
-r [ –raw ] Show raw telegram data 
-f [ –frame ] Show frame data
-s [ –serial ] Show serial port data
–tcp Show tcp packets
–ascii Show ASCII messages
–rtu Show RTU messages
-e [ –redis ] Show redis debug information 
-R [ –readyfile ] Ready notification file
```

<p class="callout warning">If Modbus Slave does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from command line interface and find out why link is not functioning properly.</p>

<p class="callout info">To launch a debugging session, a user should stop `modbus-slave` process and run `modbus-slave` command with respective flags as shown above.</p>

# 14 IEC 60870-5-10X



# 14.1 Introduction

**IEC 60870 part 5** is one of the [IEC 60870](https://en.wikipedia.org/wiki/IEC_60870 "IEC 60870") set of standards which define systems used for telecontrol ([supervisory control and data acquisition](https://en.wikipedia.org/wiki/Supervisory_control_and_data_acquisition "Supervisory control and data acquisition")) in [electrical engineering](https://en.wikipedia.org/wiki/Electrical_engineering "Electrical engineering") and [power system automation](https://en.wikipedia.org/wiki/Power_system_automation "Power system automation") applications. Part 5 provides a communication profile for sending basic telecontrol messages between two systems, which uses permanent directly connected data circuits between the systems. The [IEC Technical Committee 57](https://en.wikipedia.org/wiki/IEC_TC_57 "IEC TC 57") (Working Group 03) has developed a [protocol](https://en.wikipedia.org/wiki/Communications_protocol "Communications protocol") standard for telecontrol, teleprotection, and associated telecommunications for [electric power](https://en.wikipedia.org/wiki/Electric_power "Electric power") systems. The result of this work is IEC 60870-5. Five documents specify the base IEC 60870-5:

- IEC 60870-5-1 Transmission Frame Formats
- IEC 60870-5-2 Data Link Transmission Services
- IEC 60870-5-3 General Structure of Application Data
- IEC 60870-5-4 Definition and Coding of Information Elements
- IEC 60870-5-5 Basic Application Functions
- IEC 60870-5-6 Guidelines for conformance testing for the IEC 60870-5 companion standards
- IEC TS 60870-5-7 Security extensions to IEC 60870-5-101 and IEC 60870-5-104 protocols (applying IEC 62351)

The IEC Technical Committee 57 has also generated companion standards:

- IEC 60870-5-101 Transmission Protocols - companion standards especially for basic telecontrol tasks
- IEC 60870-5-102 Transmission Protocols - Companion standard for the transmission of integrated totals in electric power systems (this standard is not widely used)
- IEC 60870-5-103 Transmission Protocols - Companion standard for the informative interface of protection equipment
- IEC 60870-5-104 Transmission Protocols - Network access for IEC 60870-5-101 using standard transport profiles
- IEC TS 60870-5-601 Transmission protocols - Conformance test cases for the IEC 60870-5-101 companion standard
- IEC TS 60870-5-604 Conformance test cases for the IEC 60870-5-104 companion standard

IEC 60870-5-101/102/103/104 are companion standards generated for basic telecontrol tasks, transmission of integrated totals, data exchange from protection equipment &amp; network access of IEC101 respectively.

Source: [https://en.wikipedia.org/wiki/IEC\_60870-5](https://en.wikipedia.org/wiki/IEC_60870-5 "Wikipedia")

# 14.2 IEC 60870-5-101 Master

The IEC 60870-­5-­101 protocol is a companion standard for power system monitoring, control associated communications for telecontrol, teleprotection and associated telecommunications for electric power systems. Standard IEC 60870-­5­-101 was prepared by IEC technical committee 57 (Power system control and associated communications).

Standard IEC 60870-­5-­101 defines an **Application Service Data Unit** (**ASDU** Figure below). In ASDU there is an ASDU identifier (with the type of ASDU in it) and information objects.![image-1638258623652.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1638258623652.png)

IEC 60870­-5-­101 ASDU structure

**Common Address of ASDU** Defines the stations' address and can be configured in Devices asdu\_address field for source and *Signals* common\_address field for the destination.

**Information Object Address** Used as destination object address in the control direction and as source object address in monitor direction can be configured in Signals info\_address field.

Standard IEC 60870­-5­-101 transmission frames are separated into 3 different types: **frame with variable length**, **frame with fixed length,** and **single control characters**

[![image-1638259001158.png](https://wiki.elseta.com/uploads/images/gallery/2021-11/scaled-1680-/image-1638259001158.png)](https://wiki.elseta.com/uploads/images/gallery/2021-11/image-1638259001158.png)

IEC 60870­-5-­101 ASDU structure

**Control field** provides information about the message direction, type of service, and checksum.

**Address field** specifies the link address which points to the message's destination. WCC Lite supports IEC 60870-­5-­101 Master protocol over a serial link (according to EIA RS­485). Its full functionality list can be found in an <span style="color: #34495e;">[<span style="color: #236fa1;">IEC 60870­-5-­101 PID Interoperability List</span>](https://wiki.elseta.com/link/180#bkmrk-pid%27s)</span> which can be downloaded separately from this user manual.

### Configuring datapoints (master)

To use IEC 60870-­5-­101 Master in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in ­Devices and Signals.

##### IEC 60870-­5-­101 master parameters for *Devices* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 111px; height: 35px;">name

</td><td style="width: 71px; height: 35px;">string</td><td style="width: 282px; height: 35px;">User-friendly name for a device

</td><td style="width: 64px; height: 35px;">Yes</td><td style="width: 104px; height: 35px;">  
</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 109px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 111px; height: 35px;">description

</td><td style="width: 71px; height: 35px;">string</td><td style="width: 282px; height: 35px;">Description of a device

</td><td style="width: 64px; height: 35px;">No</td><td style="width: 104px; height: 35px;">  
</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 109px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 111px; height: 35px;">device\_alias

</td><td style="width: 71px; height: 35px;">string</td><td style="width: 282px; height: 35px;">Alphanumeric string to identify a device

</td><td style="width: 64px; height: 35px;">Yes</td><td style="width: 104px; height: 35px;">  
</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 109px; height: 35px;">  
</td></tr><tr style="height: 49px;"><td style="width: 111px; height: 49px;">enable</td><td style="width: 71px; height: 49px;">boolean</td><td style="width: 282px; height: 49px;">Enabling/disabling of a device

</td><td style="width: 64px; height: 49px;">No</td><td style="width: 104px; height: 49px;">1</td><td style="width: 109px; height: 49px;">0</td><td style="width: 109px; height: 49px;">1</td></tr><tr style="height: 42px;"><td style="width: 111px; height: 42px;">protocol</td><td style="width: 71px; height: 42px;">string</td><td style="width: 282px; height: 42px;">Protocol to be used

</td><td style="width: 64px; height: 42px;">Yes</td><td style="width: 104px; height: 42px;">  
</td><td colspan="2" style="width: 218px; height: 42px;">IEC 60870­-5-101 master</td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">device</td><td style="width: 71px; height: 80px;">string

</td><td style="width: 282px; height: 80px;">Communication port

</td><td style="width: 64px; height: 80px;">Yes

</td><td style="width: 104px; height: 80px;"></td><td style="width: 109px; height: 80px;">PORT1

</td><td style="width: 109px; height: 80px;">PORT2

</td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">baudrate</td><td style="width: 71px; height: 80px;">integer</td><td style="width: 282px; height: 80px;">Communication speed (bauds/s)

</td><td style="width: 64px; height: 80px;">No

</td><td style="width: 104px; height: 80px;">9600

</td><td colspan="2" style="width: 218px; height: 80px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

</td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">databits</td><td style="width: 71px; height: 80px;">integer</td><td style="width: 282px; height: 80px;">Data bit count for communication

</td><td style="width: 64px; height: 80px;">No

</td><td style="width: 104px; height: 80px;">8

</td><td style="width: 109px; height: 80px;">6

</td><td style="width: 109px; height: 80px;">9

</td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">stopbits</td><td style="width: 71px; height: 80px;">integer</td><td style="width: 282px; height: 80px;">Stop bit count for communication

</td><td style="width: 64px; height: 80px;">No

</td><td style="width: 104px; height: 80px;">1

</td><td style="width: 109px; height: 80px;">1

</td><td style="width: 109px; height: 80px;">2

</td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">parity</td><td style="width: 71px; height: 80px;">string

</td><td style="width: 282px; height: 80px;">Communication parity option

</td><td style="width: 64px; height: 80px;">No

</td><td style="width: 104px; height: 80px;">none

</td><td colspan="2" style="width: 218px; height: 80px;">none, even, odd

</td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">flowcontrol</td><td style="width: 71px; height: 80px;">string

</td><td style="width: 282px; height: 80px;">Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued

</td><td style="width: 64px; height: 80px;">No

</td><td style="width: 104px; height: 80px;">none

</td><td colspan="2" style="width: 218px; height: 80px;">none

</td></tr><tr><td style="width: 111px;">link\_address</td><td style="width: 71px;">integer</td><td style="width: 282px;">Destination address when in transmit and source address when broadcasting</td><td style="width: 64px;">Yes</td><td style="width: 104px;">  
</td><td style="width: 109px;">0</td><td style="width: 109px;">65535</td></tr><tr style="height: 29px;"><td style="width: 111px; height: 29px;">link\_size</td><td style="width: 71px; height: 29px;">integer</td><td style="width: 282px; height: 29px;">Link address size in bytes</td><td style="width: 64px; height: 29px;">No</td><td style="width: 104px; height: 29px;">1</td><td style="width: 109px; height: 29px;">1</td><td style="width: 109px; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 111px; height: 29px;">asdu\_address</td><td style="width: 71px; height: 29px;">integer</td><td style="width: 282px; height: 29px;">Application Service Data Unit address</td><td style="width: 64px; height: 29px;">Yes</td><td style="width: 104px; height: 29px;">  
</td><td style="width: 109px;">0</td><td style="width: 109px;">65535</td></tr><tr style="height: 29px;"><td style="width: 111px; height: 29px;">asdu\_size</td><td style="width: 71px; height: 29px;">integer</td><td style="width: 282px; height: 29px;">Common address size in bytes</td><td style="width: 64px; height: 29px;">No</td><td style="width: 104px; height: 29px;">1</td><td style="width: 109px; height: 29px;">1</td><td style="width: 109px; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 111px; height: 29px;">ioa\_size</td><td style="width: 71px; height: 29px;">integer</td><td style="width: 282px; height: 29px;">Information object address (IOA) size in bytes</td><td style="width: 64px; height: 29px;">No</td><td style="width: 104px; height: 29px;">2</td><td style="width: 109px; height: 29px;">1</td><td style="width: 109px; height: 29px;">3</td></tr><tr style="height: 102px;"><td style="width: 111px; height: 102px;">cot\_size</td><td style="width: 71px; height: 102px;">integer</td><td style="width: 282px; height: 102px;">Cause of transmission (COT) size in bytes</td><td style="width: 64px; height: 102px;">No</td><td style="width: 104px; height: 102px;">1</td><td style="width: 109px; height: 102px;">1</td><td style="width: 109px; height: 102px;">2</td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">time\_sync\_interval\_sec</td><td style="width: 71px; height: 80px;">integer</td><td style="width: 282px; height: 80px;">Defines how often (in seconds) slave will  
request time synchronization. **If greater than 0** ­slave will request synchronizations, will reset the timer if the master did it earlier. **If 0** slave won’t request timesyncs, but will allow them. **If ­1** ­ timesyncs are not supported ­ requests will be dropped.</td><td style="width: 64px; height: 80px;">No</td><td style="width: 104px; height: 80px;">60</td><td style="width: 109px; height: 80px;">  
</td><td style="width: 109px; height: 80px;">  
</td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">gi\_interval\_sec</td><td style="width: 71px; height: 80px;">integer</td><td style="width: 282px; height: 80px;">Time frame between General Interrogation requests in seconds, if 0 requests are disabled</td><td style="width: 64px; height: 80px;">No</td><td style="width: 104px; height: 80px;">300</td><td style="width: 109px; height: 80px;"></td><td style="width: 109px; height: 80px;"></td></tr><tr style="height: 102px;"><td style="width: 111px; height: 102px;">scan\_rate\_ms</td><td style="width: 71px; height: 102px;">integer</td><td style="width: 282px; height: 102px;">Polling interval in milliseconds. Time frame between two telegrams from master

</td><td style="width: 64px; height: 102px;">Yes</td><td style="width: 104px; height: 102px;">100</td><td style="width: 109px; height: 102px;">  
</td><td style="width: 109px; height: 102px;">  
</td></tr><tr style="height: 49px;"><td style="width: 111px; height: 49px;">timeout\_ms</td><td style="width: 71px; height: 49px;">integer</td><td style="width: 282px; height: 49px;">Response timeout in milliseconds

</td><td style="width: 64px; height: 49px;">Yes

</td><td style="width: 104px; height: 49px;">1000

</td><td style="width: 109px; height: 49px;"></td><td style="width: 109px; height: 49px;"></td></tr><tr style="height: 80px;"><td style="width: 111px; height: 80px;">retry\_count</td><td style="width: 71px; height: 80px;">integer</td><td style="width: 282px; height: 80px;">Number of retries of failed requests before announcing that device is in Error state

</td><td style="width: 64px; height: 80px;">Yes</td><td style="width: 104px; height: 80px;">1</td><td style="width: 109px; height: 80px;">  
</td><td style="width: 109px; height: 80px;">  
</td></tr></tbody></table>

##### IEC 60870­-5-­101 master parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 71.9875px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 271.987px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 92.9875px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 94.988px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.988px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9875px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 130px; height: 35px;">signal\_name

</td><td style="width: 71.9875px; height: 35px;">string</td><td style="width: 271.987px; height: 35px;">User-friendly signal name

</td><td style="width: 92.9875px; height: 35px;">Yes</td><td style="width: 94.988px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 130px; height: 35px;">device\_alias

</td><td style="width: 71.9875px; height: 35px;">string</td><td style="width: 271.987px; height: 35px;">Alphanumeric string to identify a device

</td><td style="width: 92.9875px; height: 35px;">Yes</td><td style="width: 94.988px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 130px; height: 35px;">signal\_alias

</td><td style="width: 71.9875px; height: 35px;">string</td><td style="width: 271.987px; height: 35px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 92.9875px; height: 35px;">Yes</td><td style="width: 94.988px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 49px;"><td style="width: 130px; height: 49px;">source\_device\_alias

</td><td style="width: 71.9875px; height: 49px;">string</td><td style="width: 271.987px; height: 49px;">device\_alias of a source device

</td><td style="width: 92.9875px; height: 49px;">For commands</td><td style="width: 94.988px; height: 49px;">  
</td><td style="width: 68.9875px; height: 49px;">  
</td><td style="width: 69px; height: 49px;">  
</td></tr><tr style="height: 49px;"><td style="width: 130px; height: 49px;">source\_signal\_alias

</td><td style="width: 71.9875px; height: 49px;">string</td><td style="width: 271.987px; height: 49px;">signal\_alias of a source signal

</td><td style="width: 92.9875px; height: 49px;">For  
commands</td><td style="width: 94.988px; height: 49px;">  
</td><td style="width: 68.9875px; height: 49px;">  
</td><td style="width: 69px; height: 49px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">enable</td><td style="width: 71.9875px; height: 29px;">boolean</td><td style="width: 271.987px; height: 29px;">Enabling/disabling of an individual signal

</td><td style="width: 92.9875px; height: 29px;">No</td><td style="width: 94.988px; height: 29px;">1</td><td style="width: 68.9875px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1</td></tr><tr style="height: 35px;"><td style="width: 130px; height: 35px;">log

</td><td style="width: 71.9875px; height: 35px;">integer</td><td style="width: 271.987px; height: 35px;">Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged

</td><td style="width: 92.9875px; height: 35px;">No</td><td style="width: 94.988px; height: 35px;">0</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 130px; height: 35px;">gi</td><td style="width: 71.9875px; height: 35px;">boolean</td><td style="width: 271.987px; height: 35px;">Including/excluding (1 or 0) signal from General Interrogation</td><td style="width: 92.9875px; height: 35px;">No</td><td style="width: 94.988px; height: 35px;">0</td><td style="width: 68.9875px; height: 35px;">0</td><td style="width: 69px; height: 35px;">1</td></tr><tr style="height: 35px;"><td style="width: 130px; height: 35px;">common\_address</td><td style="width: 71.9875px; height: 35px;">integer</td><td style="width: 271.987px; height: 35px;">Address of a destination device</td><td style="width: 92.9875px; height: 35px;">Yes</td><td style="width: 94.988px; height: 35px;">1</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">info\_address</td><td style="width: 71.9875px; height: 29px;">integer</td><td style="width: 271.987px; height: 29px;">Information object address</td><td style="width: 92.9875px; height: 29px;">Yes</td><td style="width: 94.988px; height: 29px;">  
</td><td style="width: 68.9875px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">data\_type</td><td style="width: 71.9875px; height: 29px;">integer</td><td style="width: 271.987px; height: 29px;">ASDU type identifier </td><td style="width: 92.9875px; height: 29px;">Yes</td><td style="width: 94.988px; height: 29px;">  
</td><td colspan="2" style="height: 29px; width: 137.988px;"><div><div>1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14, 30, 31, 32, 34, 35, 36, 45, 46, 47, 48, 49, 50</div></div></td></tr></tbody></table>

##### Device status signals

IEC 60870-­5-­101 has an additional signal which can be configured to show communication status. It is used to indicate if the slave device has disconnected from master (WCC Lite). To configure such signal for IEC 60870-­5-­101 protocol, job\_todo and tag\_job\_todo fields with string values are required. For IEC 60870-­5-­101 master required parameters for status signal will be: **signal\_name** **device\_alias, signal\_alias, common\_address, info\_address, data\_type, job\_todo** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

### Debugging a IEC 60870-­5­-101 Master application

If configuration for IEC 60870-­5-­101 devices is set up, handler for protocol will start automatically. If the configuration is missing parameters or contains errors, protocol will not start. It is done intentionally decrease unnecessary memory usage.

If IEC 60870-­5-­101 does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from command line interface and find out why link is not functioning properly. To launch a debugging session, a user should stop *iec101­-master* process and run *iec101-­master* command with respective flags as shown in the table below.

Procedure for IEC 60870-­5-­101 master service debugging:

- **Step 1**: Service must be stopped by entering the following command into the WCC Lite:  
    **/etc/init.d/iec101-­master stop**
- **Step 2**: After service is stopped it must be started with the preferred configuration file (JSON  
    files found in /etc/ folder) and a debug level 7: **iec101-­master -­c /etc/iec101-master/iec101­master.json ­-d7**  
    Additional output forming options described here: Command line arguments.
- **Step 3**: Once the problem is diagnosed normal operations can be resumed with the following  
    command: **/etc/init.d/iec101-­master start**

##### IEC 60870-­5­-101 command line debugging options

```
-h [ –help ] Display help information 
-V [ –version ] Show version
-d<debug level> Set debugging level 
-c [ –config ] Config path
-r [ –raw ] Show raw telegram data
-f [ –frame ] Show frame data
-R [ –readyfile ] Ready notification file
```

# 14.3 IEC 60870-5-101 Slave

### Configuring datapoints (slave)

To use IEC 60870­-5­-101 Slave in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in *­Devices* and *Signals.*

##### *IEC 60870-­5-­101 slave parameters for Devices tab*

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 137px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 73px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 264px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 137px; height: 10px;">name

</td><td style="width: 73px; height: 10px;">string</td><td style="width: 264px; height: 10px;">User-friendly name for a device

</td><td style="width: 79px; height: 10px;">Yes</td><td style="width: 109px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 35px;"><td style="width: 137px; height: 10px;">description

</td><td style="width: 73px; height: 10px;">string</td><td style="width: 264px; height: 10px;">Description of a device

</td><td style="width: 79px; height: 10px;">No</td><td style="width: 109px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 35px;"><td style="width: 137px; height: 10px;">device\_alias

</td><td style="width: 73px; height: 10px;">string</td><td style="width: 264px; height: 10px;">Alphanumeric string to identify a device

</td><td style="width: 79px; height: 10px;">Yes</td><td style="width: 109px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 49px;"><td style="width: 137px; height: 10px;">enable</td><td style="width: 73px; height: 10px;">boolean</td><td style="width: 264px; height: 10px;">Enabling/disabling of a device

</td><td style="width: 79px; height: 10px;">No</td><td style="width: 109px; height: 10px;">1</td><td style="width: 69px; height: 10px;">0</td><td style="width: 69px; height: 10px;">1</td></tr><tr style="height: 42px;"><td style="width: 137px; height: 10px;">protocol</td><td style="width: 73px; height: 10px;">string</td><td style="width: 264px; height: 10px;">Protocol to be used

</td><td style="width: 79px; height: 10px;">Yes</td><td style="width: 109px; height: 10px;">  
</td><td colspan="2" style="width: 138px; height: 10px;">IEC 60870­-5-101 slave</td></tr><tr style="height: 80px;"><td style="width: 137px; height: 35px;">device</td><td style="width: 73px; height: 35px;">string

</td><td style="width: 264px; height: 35px;">Communication port

</td><td style="width: 79px; height: 35px;">Yes

</td><td style="width: 109px; height: 35px;"></td><td style="width: 69px; height: 35px;">PORT1

</td><td style="width: 69px; height: 35px;">PORT2

</td></tr><tr style="height: 80px;"><td style="width: 137px; height: 10px;">baudrate</td><td style="width: 73px; height: 10px;">integer</td><td style="width: 264px; height: 10px;">Communication speed (bauds/s)

</td><td style="width: 79px; height: 10px;">No

</td><td style="width: 109px; height: 10px;">9600

</td><td colspan="2" style="width: 138px; height: 10px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

</td></tr><tr style="height: 80px;"><td style="width: 137px; height: 10px;">databits</td><td style="width: 73px; height: 10px;">integer</td><td style="width: 264px; height: 10px;">Data bit count for communication

</td><td style="width: 79px; height: 10px;">No

</td><td style="width: 109px; height: 10px;">8

</td><td style="width: 69px; height: 10px;">6

</td><td style="width: 69px; height: 10px;">9

</td></tr><tr style="height: 80px;"><td style="width: 137px; height: 10px;">stopbits</td><td style="width: 73px; height: 10px;">integer</td><td style="width: 264px; height: 10px;">Stop bit count for communication

</td><td style="width: 79px; height: 10px;">No

</td><td style="width: 109px; height: 10px;">1

</td><td style="width: 69px; height: 10px;">1

</td><td style="width: 69px; height: 10px;">2

</td></tr><tr style="height: 80px;"><td style="width: 137px; height: 10px;">parity</td><td style="width: 73px; height: 10px;">string

</td><td style="width: 264px; height: 10px;">Communication parity option

</td><td style="width: 79px; height: 10px;">No

</td><td style="width: 109px; height: 10px;">none

</td><td colspan="2" style="width: 138px; height: 10px;">none, even, odd

</td></tr><tr style="height: 80px;"><td style="width: 137px; height: 10px;">flowcontrol</td><td style="width: 73px; height: 10px;">string

</td><td style="width: 264px; height: 10px;">Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued

</td><td style="width: 79px; height: 10px;">No

</td><td style="width: 109px; height: 10px;">none

</td><td colspan="2" style="width: 138px; height: 10px;">none

</td></tr><tr style="height: 12px;"><td style="width: 137px; height: 12px;">link\_address</td><td style="width: 73px; height: 12px;">integer</td><td style="width: 264px; height: 12px;">Destination address when in transmit and source address when broadcasting</td><td style="width: 79px; height: 12px;">Yes</td><td style="width: 109px; height: 12px;">  
</td><td style="width: 69px; height: 12px;">0</td><td style="width: 69px; height: 12px;">65535</td></tr><tr style="height: 29px;"><td style="width: 137px; height: 29px;">link\_size</td><td style="width: 73px; height: 29px;">integer</td><td style="width: 264px; height: 29px;">Link address size in bytes</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">1</td><td style="width: 69px; height: 29px;">1</td><td style="width: 69px; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 137px; height: 29px;">asdu\_size</td><td style="width: 73px; height: 29px;">integer</td><td style="width: 264px; height: 29px;">Common address size in bytes</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">1</td><td style="width: 69px; height: 29px;">1</td><td style="width: 69px; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 137px; height: 10px;">ioa\_size</td><td style="width: 73px; height: 10px;">integer</td><td style="width: 264px; height: 10px;">Information object address (IOA) size in bytes</td><td style="width: 79px; height: 10px;">No</td><td style="width: 109px; height: 10px;">2</td><td style="width: 69px; height: 10px;">1</td><td style="width: 69px; height: 10px;">3</td></tr><tr style="height: 102px;"><td style="width: 137px; height: 41px;">cot\_size</td><td style="width: 73px; height: 41px;">integer</td><td style="width: 264px; height: 41px;">Cause of transmission (COT) size in bytes</td><td style="width: 79px; height: 41px;">No</td><td style="width: 109px; height: 41px;">1</td><td style="width: 69px; height: 41px;">1</td><td style="width: 69px; height: 41px;">2</td></tr><tr style="height: 80px;"><td style="width: 137px; height: 40px;">time\_sync</td><td style="width: 73px; height: 40px;">boolean</td><td style="width: 264px; height: 40px;">Allow time synchronization, 1 to enable and 0 to disable</td><td style="width: 79px; height: 40px;">No</td><td style="width: 109px; height: 40px;">0</td><td style="width: 69px; height: 40px;">0</td><td style="width: 69px; height: 40px;">1</td></tr><tr style="height: 29px;"><td style="width: 137px; height: 29px;">message\_size</td><td style="width: 73px; height: 29px;">integer</td><td style="width: 264px; height: 29px;">Maximum length of a message</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">253</td><td style="width: 69px; height: 29px;">0</td><td style="width: 69px; height: 29px;">255</td></tr><tr style="height: 29px;"><td style="width: 137px; height: 29px;">cache\_size</td><td style="width: 73px; height: 29px;">integer</td><td style="width: 264px; height: 29px;">Maximum number of events to store in a buffer</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">100</td><td style="width: 69px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1000</td></tr><tr style="height: 29px;"><td style="width: 137px; height: 29px;">respond\_delay</td><td style="width: 73px; height: 29px;">integer</td><td style="width: 264px; height: 29px;">Time in microseconds to wait before sending responses</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">100</td><td style="width: 69px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1000000</td></tr><tr style="height: 29px;"><td style="width: 137px; height: 29px;">single\_byte\_ack</td><td style="width: 73px; height: 29px;">boolean</td><td style="width: 264px; height: 29px;">Use single character acknowledge, 1 to enable and 0 to disable</td><td style="width: 79px; height: 29px;">No

</td><td style="width: 109px; height: 29px;">0</td><td style="width: 69px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1</td></tr><tr><td style="width: 137px;">keep\_alive\_timeout</td><td style="width: 73px;">integer</td><td style="width: 264px;">Time interval in seconds before serial  
connection is considered offline</td><td style="width: 79px;">No

</td><td style="width: 109px;">60</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr></tbody></table>

**keep\_alive\_timeout** timer is used for connection tracker to display protocol status. This parameter has no effect on protocol functionality and is only used to track it’s status in connection tracker.

##### IEC 60870­-5-­101 slave parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 645.113px;"><tbody><tr style="height: 61.9886px;"><td class="align-center" rowspan="2" style="height: 112.983px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 112.983px; width: 71.9625px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 112.983px; width: 271.975px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 112.983px; width: 86.9875px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 112.983px; width: 100.975px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 61.9886px; width: 137.988px;">**Range**

</td></tr><tr style="height: 50.9943px;"><td class="align-center" style="height: 50.9943px; width: 68.9875px;">Min

</td><td class="align-center" style="height: 50.9943px; width: 69px;">Max

</td></tr><tr style="height: 35.2983px;"><td style="width: 130px; height: 35.2983px;">signal\_name

</td><td style="width: 71.9625px; height: 35.2983px;">string</td><td style="width: 271.975px; height: 35.2983px;">User-friendly signal name

</td><td style="width: 86.9875px; height: 35.2983px;">Yes</td><td style="width: 100.975px; height: 35.2983px;">  
</td><td style="width: 68.9875px; height: 35.2983px;">  
</td><td style="width: 69px; height: 35.2983px;">  
</td></tr><tr style="height: 35.2983px;"><td style="width: 130px; height: 35.2983px;">device\_alias

</td><td style="width: 71.9625px; height: 35.2983px;">string</td><td style="width: 271.975px; height: 35.2983px;">Alphanumeric string to identify a device

</td><td style="width: 86.9875px; height: 35.2983px;">Yes</td><td style="width: 100.975px; height: 35.2983px;">  
</td><td style="width: 68.9875px; height: 35.2983px;">  
</td><td style="width: 69px; height: 35.2983px;">  
</td></tr><tr style="height: 57.6989px;"><td style="width: 130px; height: 57.6989px;">signal\_alias

</td><td style="width: 71.9625px; height: 57.6989px;">string</td><td style="width: 271.975px; height: 57.6989px;">Unique alphanumeric name of the signal to be Yes used

</td><td style="width: 86.9875px; height: 57.6989px;">Yes</td><td style="width: 100.975px; height: 57.6989px;">  
</td><td style="width: 68.9875px; height: 57.6989px;">  
</td><td style="width: 69px; height: 57.6989px;">  
</td></tr><tr style="height: 66.0369px;"><td style="width: 130px; height: 66.0369px;">source\_device\_alias

</td><td style="width: 71.9625px; height: 66.0369px;">string</td><td style="width: 271.975px; height: 66.0369px;">device\_alias of a source device

</td><td style="width: 86.9875px; height: 66.0369px;">For commands</td><td style="width: 100.975px; height: 66.0369px;">  
</td><td style="width: 68.9875px; height: 66.0369px;">  
</td><td style="width: 69px; height: 66.0369px;">  
</td></tr><tr style="height: 66.0369px;"><td style="width: 130px; height: 66.0369px;">source\_signal\_alias

</td><td style="width: 71.9625px; height: 66.0369px;">string</td><td style="width: 271.975px; height: 66.0369px;">signal\_alias of a source signal

</td><td style="width: 86.9875px; height: 66.0369px;">For  
commands</td><td style="width: 100.975px; height: 66.0369px;">  
</td><td style="width: 68.9875px; height: 66.0369px;">  
</td><td style="width: 69px; height: 66.0369px;">  
</td></tr><tr style="height: 35.2983px;"><td style="width: 130px; height: 35.2983px;">enable</td><td style="width: 71.9625px; height: 35.2983px;">boolean</td><td style="width: 271.975px; height: 35.2983px;">Enabling/disabling of an individual signal

</td><td style="width: 86.9875px; height: 35.2983px;">No</td><td style="width: 100.975px; height: 35.2983px;">1</td><td style="width: 68.9875px; height: 35.2983px;">0</td><td style="width: 69px; height: 35.2983px;">1</td></tr><tr style="height: 80.0994px;"><td style="width: 130px; height: 80.0994px;">log

</td><td style="width: 71.9625px; height: 80.0994px;">integer</td><td style="width: 271.975px; height: 80.0994px;">Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged

</td><td style="width: 86.9875px; height: 80.0994px;">No</td><td style="width: 100.975px; height: 80.0994px;">0</td><td style="width: 68.9875px; height: 80.0994px;">  
</td><td style="width: 69px; height: 80.0994px;">  
</td></tr><tr style="height: 46.5057px;"><td style="width: 130px; height: 46.5057px;">gi</td><td style="width: 71.9625px; height: 46.5057px;">boolean</td><td style="width: 271.975px; height: 46.5057px;">Including/excluding (1 or 0) signal from General Interrogation</td><td style="width: 86.9875px; height: 46.5057px;">No</td><td style="width: 100.975px; height: 46.5057px;">0</td><td style="width: 68.9875px; height: 46.5057px;">0</td><td style="width: 69px; height: 46.5057px;">1</td></tr><tr style="height: 35px;"><td style="width: 130px; height: 35px;">common\_address</td><td style="width: 71.9625px; height: 35px;">integer</td><td style="width: 271.975px; height: 35px;">Address of a destination device</td><td style="width: 86.9875px; height: 35px;">Yes</td><td style="width: 100.975px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 130px; height: 29.7017px;">info\_address</td><td style="width: 71.9625px; height: 29.7017px;">integer</td><td style="width: 271.975px; height: 29.7017px;">Information object address</td><td style="width: 86.9875px; height: 29.7017px;">Yes</td><td style="width: 100.975px; height: 29.7017px;">  
</td><td style="width: 68.9875px; height: 29.7017px;">  
</td><td style="width: 69px; height: 29.7017px;">  
</td></tr><tr style="height: 45.1562px;"><td style="width: 130px; height: 45.1562px;">data\_type</td><td style="width: 71.9625px; height: 45.1562px;">integer</td><td style="width: 271.975px; height: 45.1562px;">ASDU type identifier</td><td style="width: 86.9875px; height: 45.1562px;">Yes</td><td style="width: 100.975px; height: 45.1562px;">  
</td><td colspan="2" style="height: 45.1562px; width: 137.988px;"><div><div>1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14, 30, 31, 32, 34, 35, 36, 45, 46, 47, 48, 49, 50, 58, 59, 60, 61, 62, 63</div></div></td></tr></tbody></table>

##### Device status signals

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk-" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>IEC 60870-­5-­101 has an additional signal which can be configured to show communication status. It is used to indicate if the master device has disconnected from slave (WCC Lite). To configure such signal for IEC 60870-­5-­101 protocol, job\_todo and tag\_job\_todo fields with string values are required. For IEC 60870-­5-­101 slave required parameters for status signal will be: **signal\_name** **device\_alias, signal\_alias, common\_address, info\_address, data\_type, job\_todo** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

### Debugging an IEC 60870-­5­-101 slave application

If the configuration for IEC 60870-­5-­101 devices is set up, the handler for the protocol will start automatically. If the configuration is missing parameters or contains errors, the protocol will not start. It is done intentionally to decrease unnecessary memory usage.

If IEC 60870-­5-­101 does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from the command-line interface and find out why the link is not functioning properly. To launch a debugging session, a user should stop the *iec101­-slave* process and run the *iec101-­slave* command with respective flags as shown in the table below.

Procedure for IEC 60870-­5-­101 slave service debugging:

- **Step 1**: Service must be stopped by entering the following command into the WCC Lite:  
    **/etc/init.d/iec101-­slave stop**
- **Step 2**: After service is stopped it must be started with the preferred configuration file (JSON  
    files found in /etc/ folder) and a debug level 7: **iec101-­slave-­c /etc/iec101-slave/iec101slave.json ­-d7**  
    Additional output forming options described here: Command line arguments.
- **Step 3**: Once the problem is diagnosed normal operations can be resumed with the following  
    command: **/etc/init.d/iec101-­slave start**

##### IEC 60870-­5­-101 command line debugging options

```
-h [ –help ] Display help information 
-V [ –version ] Show version
-d<debug level> Set debugging level 
-c [ –config ] Config path
-r [ –raw ] Show raw telegram data
-f [ –frame ] Show frame data
-R [ –readyfile ] Ready notification file
```

# 14.4 IEC 60870-5-103 Master

The IEC 60870-5-103 protocol is a companion standard for the informative interface of protection equipment. Standard IEC 60870-5-103 was prepared by IEC technical committee 57 (Power system control and associated communications). It is a companion standard for the basic standards in series IEC 60870-5:

Standard IEC 60870-5-103 defines communication between protection equipment and devices of a control system (supervisor or RTU) in a substation.

Standard IEC 60870-5-103 defines a multipoint communication protocol via which information can be exchanged between a control system (supervisor or RTU) and one or more protection devices. The control system is the master and the protection devices are the slaves. Each slave is identified by a unique address between 1 and 254. Address 255 is reserved for broadcast frames.

### IEC 60870-5-103 Master

### Configuring datapoints

WCC Lite supports IEC 60870-5-103 Master protocol over a serial link (according to EIA RS-485). Its full functionality list can be found in an <span style="color: #236fa1;">[IEC 60870-5-103 PID Interoperability List](https://wiki.elseta.com/link/180#bkmrk-pid%27s)</span>.

To use IEC 60870-5-103 Master in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in - Devices and Signals.

##### IEC 60870-­5-­103 parameters for Devices tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 1453.8px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 113px; width: 163px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 74px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 237px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 62px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35.2px;"><td style="width: 163px; height: 35.2px;">name

</td><td style="width: 74px; height: 35.2px;">string</td><td style="width: 237px; height: 35.2px;">User-friendly name for a device

</td><td style="width: 79px; height: 35.2px;">Yes</td><td style="width: 109px; height: 35.2px;">  
</td><td style="width: 69px; height: 35.2px;">  
</td><td style="width: 69px; height: 35.2px;">  
</td></tr><tr style="height: 35.2px;"><td style="width: 163px; height: 35.2px;">description

</td><td style="width: 74px; height: 35.2px;">string</td><td style="width: 237px; height: 35.2px;">Description of a device

</td><td style="width: 79px; height: 35.2px;">No</td><td style="width: 109px; height: 35.2px;">  
</td><td style="width: 69px; height: 35.2px;">  
</td><td style="width: 69px; height: 35.2px;">  
</td></tr><tr style="height: 35.2px;"><td style="width: 163px; height: 35.2px;">device\_alias

</td><td style="width: 74px; height: 35.2px;">string</td><td style="width: 237px; height: 35.2px;">Alphanumeric string to identify a device

</td><td style="width: 79px; height: 35.2px;">Yes</td><td style="width: 109px; height: 35.2px;">  
</td><td style="width: 69px; height: 35.2px;">  
</td><td style="width: 69px; height: 35.2px;">  
</td></tr><tr style="height: 49px;"><td style="width: 163px; height: 49px;">enable</td><td style="width: 74px; height: 49px;">boolean</td><td style="width: 237px; height: 49px;">Enabling/disabling of a device

</td><td style="width: 79px; height: 49px;">No</td><td style="width: 109px; height: 49px;">1</td><td style="width: 69px; height: 49px;">0</td><td style="width: 69px; height: 49px;">1</td></tr><tr style="height: 48.8px;"><td style="width: 163px; height: 48.8px;">protocol</td><td style="width: 74px; height: 48.8px;">string</td><td style="width: 237px; height: 48.8px;">Protocol to be used

</td><td style="width: 79px; height: 48.8px;">Yes</td><td style="width: 109px; height: 48.8px;">  
</td><td colspan="2" style="width: 138px; height: 48.8px;">IEC 60870­-5-103 master</td></tr><tr style="height: 80px;"><td style="width: 163px; height: 80px;">device</td><td style="width: 74px; height: 80px;">string

</td><td style="width: 237px; height: 80px;">Communication port

</td><td style="width: 79px; height: 80px;">Yes

</td><td style="width: 109px; height: 80px;"></td><td style="width: 69px; height: 80px;">PORT1

</td><td style="width: 69px; height: 80px;">PORT2

</td></tr><tr style="height: 102.4px;"><td style="width: 163px; height: 102.4px;">baudrate</td><td style="width: 74px; height: 102.4px;">integer</td><td style="width: 237px; height: 102.4px;">Communication speed (bauds/s)

</td><td style="width: 79px; height: 102.4px;">No

</td><td style="width: 109px; height: 102.4px;">9600

</td><td colspan="2" style="width: 138px; height: 102.4px;">600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

</td></tr><tr style="height: 80px;"><td style="width: 163px; height: 80px;">databits</td><td style="width: 74px; height: 80px;">integer</td><td style="width: 237px; height: 80px;">Data bit count for communication

</td><td style="width: 79px; height: 80px;">No

</td><td style="width: 109px; height: 80px;">8

</td><td colspan="2" style="width: 138px; height: 80px;">8

</td></tr><tr style="height: 80px;"><td style="width: 163px; height: 80px;">stopbits</td><td style="width: 74px; height: 80px;">integer</td><td style="width: 237px; height: 80px;">Stop bit count for communication

</td><td style="width: 79px; height: 80px;">No

</td><td style="width: 109px; height: 80px;">1

</td><td style="width: 69px; height: 80px;">1

</td><td style="width: 69px; height: 80px;">2

</td></tr><tr style="height: 80px;"><td style="width: 163px; height: 80px;">parity</td><td style="width: 74px; height: 80px;">string

</td><td style="width: 237px; height: 80px;">Communication parity option

</td><td style="width: 79px; height: 80px;">No

</td><td style="width: 109px; height: 80px;">none

</td><td colspan="2" style="width: 138px; height: 80px;">none, even, odd

</td></tr><tr style="height: 102.4px;"><td style="width: 163px; height: 102.4px;">flowcontrol</td><td style="width: 74px; height: 102.4px;">string

</td><td style="width: 237px; height: 102.4px;">Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued

</td><td style="width: 79px; height: 102.4px;">No

</td><td style="width: 109px; height: 102.4px;">none

</td><td colspan="2" style="width: 138px; height: 102.4px;">none

</td></tr><tr style="height: 46.4px;"><td style="width: 163px; height: 46.4px;">link\_address</td><td style="width: 74px; height: 46.4px;">integer</td><td style="width: 237px; height: 46.4px;">Destination address when in transmit and source address when broadcasting</td><td style="width: 79px; height: 46.4px;">Yes</td><td style="width: 109px; height: 46.4px;">  
</td><td style="width: 69px; height: 46.4px;">0</td><td style="width: 69px; height: 46.4px;">65535</td></tr><tr style="height: 29.6px;"><td style="width: 163px; height: 29.6px;">asdu\_address</td><td style="width: 74px; height: 29.6px;">integer</td><td style="width: 237px; height: 29.6px;">Application Service Data Unit address</td><td style="width: 79px; height: 29.6px;">Yes</td><td style="width: 109px; height: 29.6px;">  
</td><td style="width: 69px; height: 29.6px;"> 0</td><td style="width: 69px; height: 29.6px;">65535 </td></tr><tr style="height: 80px;"><td style="width: 163px; height: 80px;">time\_sync\_interval\_sec</td><td style="width: 74px; height: 80px;">integer</td><td style="width: 237px; height: 80px;">Time frame between Time Synchronization  
requests in seconds</td><td style="width: 79px; height: 80px;">No</td><td style="width: 109px; height: 80px;">60</td><td style="width: 69px; height: 80px;">  
</td><td style="width: 69px; height: 80px;">  
</td></tr><tr style="height: 65.6px;"><td style="width: 163px; height: 65.6px;">gi\_interval\_sec</td><td style="width: 74px; height: 65.6px;">integer</td><td style="width: 237px; height: 65.6px;">Time frame between General Interrogation requests in seconds, if 0 requests are disabled</td><td style="width: 79px; height: 65.6px;">Yes</td><td style="width: 109px; height: 65.6px;">300</td><td style="width: 69px; height: 65.6px;"></td><td style="width: 69px; height: 65.6px;"></td></tr><tr style="height: 80px;"><td style="width: 163px; height: 80px;">scan\_rate\_ms</td><td style="width: 74px; height: 80px;">integer</td><td style="width: 237px; height: 80px;">Polling interval in milliseconds. Time frame between two telegrams from master

</td><td style="width: 79px; height: 80px;">No</td><td style="width: 109px; height: 80px;">100</td><td style="width: 69px; height: 80px;">  
</td><td style="width: 69px; height: 80px;">  
</td></tr><tr style="height: 49px;"><td style="width: 163px; height: 49px;">timeout\_ms</td><td style="width: 74px; height: 49px;">integer</td><td style="width: 237px; height: 49px;">Response timeout in milliseconds

</td><td style="width: 79px; height: 49px;">No

</td><td style="width: 109px; height: 49px;">1000

</td><td style="width: 69px; height: 49px;"></td><td style="width: 69px; height: 49px;"></td></tr><tr style="height: 102px;"><td style="width: 163px; height: 102px;">serial\_delay</td><td style="width: 74px; height: 102px;">integer</td><td style="width: 237px; height: 102px;">Communication device’s serial delay in milliseconds. Time frame in which master station is not TX’ing after last RX byte</td><td style="width: 79px; height: 102px;">No</td><td style="width: 109px; height: 102px;">50</td><td style="width: 69px; height: 102px;">  
</td><td style="width: 69px; height: 102px;">  
</td></tr><tr style="height: 80px;"><td style="width: 163px; height: 80px;">retry\_count</td><td style="width: 74px; height: 80px;">integer</td><td style="width: 237px; height: 80px;">Number of retries of failed requests before announcing that device is in Error state

</td><td style="width: 79px; height: 80px;">No</td><td style="width: 109px; height: 80px;">3</td><td style="width: 69px; height: 80px;">  
</td><td style="width: 69px; height: 80px;">  
</td></tr><tr style="height: 80px;"><td style="width: 163px; height: 80px;">retry\_delay\_ms</td><td style="width: 74px; height: 80px;">integer</td><td style="width: 237px; height: 80px;">Time before the next retry in milliseconds</td><td style="width: 79px; height: 80px;">No</td><td style="width: 109px; height: 80px;">500</td><td style="width: 69px; height: 80px;">  
</td><td style="width: 69px; height: 80px;">  
</td></tr></tbody></table>

##### IEC 60870­-5-­103 master parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 138px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 70.9875px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 264.975px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 84.9875px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 102.988px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.988px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9875px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 138px; height: 35px;">signal\_name

</td><td style="width: 70.9875px; height: 35px;">string</td><td style="width: 264.975px; height: 35px;">User-friendly signal name

</td><td style="width: 84.9875px; height: 35px;">Yes</td><td style="width: 102.988px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 138px; height: 10px;">device\_alias

</td><td style="width: 70.9875px; height: 10px;">string</td><td style="width: 264.975px; height: 10px;">Alphanumeric string to identify a device

</td><td style="width: 84.9875px; height: 10px;">Yes</td><td style="width: 102.988px; height: 10px;">  
</td><td style="width: 68.9875px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 35px;"><td style="width: 138px; height: 35px;">signal\_alias

</td><td style="width: 70.9875px; height: 35px;">string</td><td style="width: 264.975px; height: 35px;">Unique alphanumeric name of the signal to be Yes used

</td><td style="width: 84.9875px; height: 35px;">Yes</td><td style="width: 102.988px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 49px;"><td style="width: 138px; height: 10px;">source\_device\_alias

</td><td style="width: 70.9875px; height: 10px;">string</td><td style="width: 264.975px; height: 10px;">device\_alias of a source device

</td><td style="width: 84.9875px; height: 10px;">For commands</td><td style="width: 102.988px; height: 10px;">  
</td><td style="width: 68.9875px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 49px;"><td style="width: 138px; height: 10px;">source\_signal\_alias

</td><td style="width: 70.9875px; height: 10px;">string</td><td style="width: 264.975px; height: 10px;">signal\_alias of a source signal

</td><td style="width: 84.9875px; height: 10px;">For  
commands</td><td style="width: 102.988px; height: 10px;">  
</td><td style="width: 68.9875px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 29px;"><td style="width: 138px; height: 29px;">enable</td><td style="width: 70.9875px; height: 29px;">boolean</td><td style="width: 264.975px; height: 29px;">Enabling/disabling of an individual signal

</td><td style="width: 84.9875px; height: 29px;">No</td><td style="width: 102.988px; height: 29px;">1</td><td style="width: 68.9875px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1</td></tr><tr style="height: 35px;"><td style="width: 138px; height: 35px;">log

</td><td style="width: 70.9875px; height: 35px;">integer</td><td style="width: 264.975px; height: 35px;">Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged

</td><td style="width: 84.9875px; height: 35px;">No</td><td style="width: 102.988px; height: 35px;">0</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 138px; height: 35px;">gi</td><td style="width: 70.9875px; height: 35px;">boolean</td><td style="width: 264.975px; height: 35px;">Including/excluding (1 or 0) signal from General Interrogation</td><td style="width: 84.9875px; height: 35px;">No</td><td style="width: 102.988px; height: 35px;">0</td><td style="width: 68.9875px; height: 35px;">0</td><td style="width: 69px; height: 35px;">1</td></tr><tr style="height: 35px;"><td style="width: 138px; height: 35px;">common\_address</td><td style="width: 70.9875px; height: 35px;">integer</td><td style="width: 264.975px; height: 35px;">Address of a destination device</td><td style="width: 84.9875px; height: 35px;">Yes</td><td style="width: 102.988px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 138px; height: 29px;">function</td><td style="width: 70.9875px; height: 29px;">integer</td><td style="width: 264.975px; height: 29px;">Function number</td><td style="width: 84.9875px; height: 29px;">No</td><td style="width: 102.988px; height: 29px;">0</td><td style="width: 68.9875px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 138px; height: 29px;">info\_address</td><td style="width: 70.9875px; height: 29px;">integer</td><td style="width: 264.975px; height: 29px;">Information object address</td><td style="width: 84.9875px; height: 29px;">Yes</td><td style="width: 102.988px; height: 29px;">  
</td><td style="width: 68.9875px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 138px; height: 29px;">info\_number</td><td style="width: 70.9875px; height: 29px;">integer</td><td style="width: 264.975px; height: 29px;">Information number</td><td style="width: 84.9875px; height: 29px;">Yes</td><td style="width: 102.988px; height: 29px;">  
</td><td style="width: 68.9875px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 138px; height: 29px;">data\_type</td><td style="width: 70.9875px; height: 29px;">integer</td><td style="width: 264.975px; height: 29px;">ASDU type identifier</td><td style="width: 84.9875px; height: 29px;">No</td><td style="width: 102.988px; height: 29px;">0</td><td colspan="2" style="height: 29px; width: 137.988px;"><div><div>0, 1, 2, 3, 4, 9, 20</div></div></td></tr><tr style="height: 63px;"><td style="width: 138px; height: 63px;">fleeting</td><td style="width: 70.9875px; height: 63px;">boolean</td><td style="width: 264.975px; height: 63px;">Mark signal as fleeting type (1 or 0). Fleeting signals have go to DPI::OFF after defined time</td><td style="width: 84.9875px; height: 63px;">No</td><td style="width: 102.988px; height: 63px;">  
</td><td style="width: 68.9875px; height: 63px;">0</td><td style="width: 69px; height: 63px;">1</td></tr><tr style="height: 63px;"><td style="width: 138px; height: 63px;">normalise\_time\_ms</td><td style="width: 70.9875px; height: 63px;">integer</td><td style="width: 264.975px; height: 63px;">Time in milliseconds between station receiving DPI::ON and automatically switching to DPI::OFF</td><td style="width: 84.9875px; height: 63px;">If fleeting is used </td><td style="width: 102.988px; height: 63px;">100</td><td style="width: 68.9875px; height: 63px;">  
</td><td style="width: 69px; height: 63px;">  
</td></tr></tbody></table>

##### Device status signals

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk--0" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>IEC 60870-­5-­103 has an additional signal which can be configured to show communication status. It is used to indicate if the slave device has disconnected from master (WCC Lite). To configure such signal for IEC 60870-­5-­103 protocol, job\_todo and tag\_job\_todo fields with string values are required. For IEC 60870-­5-­103 master required parameters for status signal will be: **signal\_name** **device\_alias, signal\_alias, common\_address, info\_address, info\_number, job\_todo** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

### Debugging an IEC 60870-5-103 Master application

If the configuration for IEC 60870-5-103 devices is set up, the handler for the protocol will start automatically. If a configuration is missing parameters or contains errors, the protocol will not start. It is done intentionally to decrease unnecessary memory usage.

If IEC 60870-5-103 does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from the command-line interface and find out why the link is not functioning properly or use WCC Utility to do that.

To launch a debugging session, a user should stop the iec103-master process and run the iec103-master command with respective flags.

- Step 1: Service must be stopped by entering the following command into the WCC Lite:  
    **/etc/init.d/iec103-­master stop**
- Step 2: After service is stopped it must be started with the preferred configuration file (JSON  
    files found in /etc/ folder) and a debug level 7: **iec103-­master ­-c /etc/iec103-master/iec103-­master.json -­d7**
- Step 3: Once the problem is diagnosed normal operations can be resumed with the following command: **/etc/init.d/iec103-­master start**

##### IEC 60870-­5­-103 command line debugging options

```
-h [ –help ] Display help information 
-V [ –version ] Show version
-d<debug level> Set debugging level 
-c [ –config ] Config path
-r [ –raw ] Show raw telegram data
-f [ –frame ] Show frame data
-R [ –readyfile ] Ready notification file
```

# 14.5 IEC 60870-5-104 Master

IEC 60870-5-104 protocol (in short IEC 104) is a part of IEC Telecontrol Equipment and Systems Standard IEC 60870-5 that provides a communication profile for sending basic telecontrol messages between two systems in electrical engineering and power system automation. Telecontrol means transmitting supervisory data and data acquisition requests for controlling power transmission grids.

IEC 104 provides network access to IEC 60870-5-101 (in short IEC 101) using standard transport profiles. In simple terms, it delivers IEC 101 messages as application data (L7) over TCP, usually port 2404. IEC 104 enables the communication between the control station and a substation via a standard TCP/IP network. The communication is based on the client-server model.

<p class="callout info">To set up TLS connection for both IEC104 Master and Slave, refer to sections Excel configuration and Certificates. All keys and certificates should be provided in the PEM format.</p>

<p class="callout warning">If no configuration is set up, IEC104 Master and Slave services are not started.</p>

#### Configuring IEC 104 Master datapoints

To use IEC 60870-­5-­104 Master in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in ­ Devices and Signals.

##### IEC 60870­-5-­104 Master parameters for *Devices* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 1007.67px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 113px; width: 158px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 71px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 245px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 62px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35.3906px;"><td style="width: 158px; height: 35.3906px;">name

</td><td style="width: 71px; height: 35.3906px;">string</td><td style="width: 245px; height: 35.3906px;">User-friendly name for a device

</td><td style="width: 79px; height: 35.3906px;">Yes</td><td style="width: 109px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 158px; height: 35.3906px;">description

</td><td style="width: 71px; height: 35.3906px;">string</td><td style="width: 245px; height: 35.3906px;">Description of a device

</td><td style="width: 79px; height: 35.3906px;">No</td><td style="width: 109px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 158px; height: 35.3906px;">device\_alias

</td><td style="width: 71px; height: 35.3906px;">string</td><td style="width: 245px; height: 35.3906px;">Alphanumeric string to identify a device

</td><td style="width: 79px; height: 35.3906px;">Yes</td><td style="width: 109px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td></tr><tr style="height: 49px;"><td style="width: 158px; height: 49px;">enable</td><td style="width: 71px; height: 49px;">boolean</td><td style="width: 245px; height: 49px;">Enabling/disabling of a device

</td><td style="width: 79px; height: 49px;">No</td><td style="width: 109px; height: 49px;">1</td><td style="width: 69px; height: 49px;">0</td><td style="width: 69px; height: 49px;">1</td></tr><tr style="height: 49.5938px;"><td style="width: 158px; height: 49.5938px;">protocol</td><td style="width: 71px; height: 49.5938px;">string</td><td style="width: 245px; height: 49.5938px;">Protocol to be used

</td><td style="width: 79px; height: 49.5938px;">Yes</td><td style="width: 109px; height: 49.5938px;">  
</td><td colspan="2" style="width: 138px; height: 49.5938px;">IEC 60870­-5-104 master</td></tr><tr style="height: 29.7969px;"><td style="width: 158px; height: 29.7969px;">asdu\_address</td><td style="width: 71px; height: 29.7969px;">integer</td><td style="width: 245px; height: 29.7969px;">Application Service Data Unit address</td><td style="width: 79px; height: 29.7969px;">Yes</td><td style="width: 109px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">0</td><td style="width: 69px; height: 29.7969px;">65535</td></tr><tr style="height: 29.7969px;"><td style="width: 158px; height: 29.7969px;">asdu\_size</td><td style="width: 71px; height: 29.7969px;">integer</td><td style="width: 245px; height: 29.7969px;">Common address size in bytes</td><td style="width: 79px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">2</td><td style="width: 69px; height: 29.7969px;">1</td><td style="width: 69px; height: 29.7969px;">2</td></tr><tr style="height: 63.3906px;"><td style="width: 158px; height: 63.3906px;">time\_sync\_interval\_sec</td><td style="width: 71px; height: 63.3906px;">integer</td><td style="width: 245px; height: 63.3906px;">Time frame between Time Synchronization  
requests in seconds</td><td style="width: 79px; height: 63.3906px;">Yes</td><td style="width: 109px; height: 63.3906px;">60</td><td style="width: 69px; height: 63.3906px;">  
</td><td style="width: 69px; height: 63.3906px;">  
</td></tr><tr style="height: 80.1719px;"><td style="width: 158px; height: 80.1719px;">gi\_interval\_sec</td><td style="width: 71px; height: 80.1719px;">integer</td><td style="width: 245px; height: 80.1719px;">Time frame between General Interrogation requests in seconds.

If 0 requests are disabled

</td><td style="width: 79px; height: 80.1719px;">Yes</td><td style="width: 109px; height: 80.1719px;">300</td><td style="width: 69px; height: 80.1719px;"></td><td style="width: 69px; height: 80.1719px;"></td></tr><tr style="height: 80px;"><td style="width: 158px; height: 80px;">port</td><td style="width: 71px; height: 80px;">integer</td><td style="width: 245px; height: 80px;">TCP port</td><td style="width: 79px; height: 80px;">Yes</td><td style="width: 109px; height: 80px;">  
</td><td style="height: 80px; width: 69px;">0</td><td style="width: 69px; height: 80px;">65535</td></tr><tr style="height: 46.5938px;"><td style="width: 158px; height: 46.5938px;">ioa\_size</td><td style="width: 71px; height: 46.5938px;">integer</td><td style="width: 245px; height: 46.5938px;">Information object address (IOA) size in bytes</td><td style="width: 79px; height: 46.5938px;">No</td><td style="width: 109px; height: 46.5938px;">3</td><td style="width: 69px; height: 46.5938px;">1</td><td style="width: 69px; height: 46.5938px;">3</td></tr><tr style="height: 29.7969px;"><td style="width: 158px; height: 29.7969px;">swt</td><td style="width: 71px; height: 29.7969px;">integer</td><td style="width: 245px; height: 29.7969px;">Send window (k)</td><td style="width: 79px; height: 29.7969px;">Yes  
</td><td style="width: 109px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 158px; height: 29.7969px;">rwt</td><td style="width: 71px; height: 29.7969px;">integer</td><td style="width: 245px; height: 29.7969px;">Receive window (w)</td><td style="width: 79px; height: 29.7969px;">Yes  
</td><td style="width: 109px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 158px; height: 29.7969px;">cot\_size</td><td style="width: 71px; height: 29.7969px;">integer</td><td style="width: 245px; height: 29.7969px;">Cause of transmission (COT) size in bytes</td><td style="width: 79px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">2</td><td style="width: 69px; height: 29.7969px;">1</td><td style="width: 69px; height: 29.7969px;">3</td></tr><tr style="height: 31.7969px;"><td style="width: 158px; height: 31.7969px;">ip</td><td style="width: 71px; height: 31.7969px;">string</td><td style="width: 245px; height: 31.7969px;">Host IP address (ipv4)</td><td style="width: 79px; height: 31.7969px;">Yes</td><td style="width: 109px; height: 31.7969px;">  
</td><td style="width: 69px; height: 31.7969px;">  
</td><td style="width: 69px; height: 31.7969px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 158px; height: 35.3906px;">t1\*

</td><td style="width: 71px; height: 35.3906px;">integer</td><td style="width: 245px; height: 35.3906px;">Acknowledge timeout t1 (sec)</td><td style="width: 79px; height: 35.3906px;">Yes</td><td style="width: 109px; height: 35.3906px;">15</td><td style="width: 69px; height: 35.3906px;">1</td><td style="width: 69px; height: 35.3906px;">255</td></tr><tr style="height: 34px;"><td style="width: 158px; height: 34px;">t2\*</td><td style="width: 71px; height: 34px;">integer</td><td style="width: 245px; height: 34px;">Connection ACKRSN clock t2 (sec)</td><td style="width: 79px; height: 34px;">Yes</td><td style="width: 109px; height: 34px;">10</td><td style="width: 69px; height: 34px;">1</td><td style="width: 69px; height: 34px;">254</td></tr><tr style="height: 29.7969px;"><td style="width: 158px; height: 29.7969px;">t3\*</td><td style="width: 71px; height: 29.7969px;">integer</td><td style="width: 245px; height: 29.7969px;">Connection TESTFR clock t3 (sec)</td><td style="width: 79px; height: 29.7969px;">Yes</td><td style="width: 109px; height: 29.7969px;">20</td><td style="width: 69px; height: 29.7969px;">1</td><td style="width: 69px; height: 29.7969px;"><div><div>172800</div></div></td></tr><tr style="height: 46.5938px;"><td style="width: 158px; height: 46.5938px;">originator</td><td style="width: 71px; height: 46.5938px;">integer</td><td style="width: 245px; height: 46.5938px;">Provides a means for a controlling station to explicitly identify itself</td><td style="width: 79px; height: 46.5938px;">No</td><td style="width: 109px; height: 46.5938px;">0</td><td style="width: 69px; height: 46.5938px;">0</td><td style="width: 69px; height: 46.5938px;">255</td></tr></tbody></table>

\* - t1, t2 and t3 parameters must meet the inequality: t2&lt;t1&lt;t3.

##### IEC 60870­-5-­104 Master parameters for *Signals*

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 141px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 67.9875px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 264.975px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 87.9875px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 99.9875px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.988px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9875px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 141px; height: 35px;">signal\_name

</td><td style="width: 67.9875px; height: 35px;">string</td><td style="width: 264.975px; height: 35px;">User-friendly signal name

</td><td style="width: 87.9875px; height: 35px;">Yes</td><td style="width: 99.9875px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 141px; height: 10px;">device\_alias

</td><td style="width: 67.9875px; height: 10px;">string</td><td style="width: 264.975px; height: 10px;">Alphanumeric string to identify a device

</td><td style="width: 87.9875px; height: 10px;">Yes</td><td style="width: 99.9875px; height: 10px;">  
</td><td style="width: 68.9875px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 35px;"><td style="width: 141px; height: 35px;">signal\_alias

</td><td style="width: 67.9875px; height: 35px;">string</td><td style="width: 264.975px; height: 35px;">Unique alphanumeric name of the signal to be Yes used

</td><td style="width: 87.9875px; height: 35px;">Yes</td><td style="width: 99.9875px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 49px;"><td style="width: 141px; height: 10px;">source\_device\_alias

</td><td style="width: 67.9875px; height: 10px;">string</td><td style="width: 264.975px; height: 10px;">device\_alias of a source device

</td><td style="width: 87.9875px; height: 10px;">For commands</td><td style="width: 99.9875px; height: 10px;">  
</td><td style="width: 68.9875px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 49px;"><td style="width: 141px; height: 10px;">source\_signal\_alias

</td><td style="width: 67.9875px; height: 10px;">string</td><td style="width: 264.975px; height: 10px;">signal\_alias of a source signal

</td><td style="width: 87.9875px; height: 10px;">For  
commands</td><td style="width: 99.9875px; height: 10px;">  
</td><td style="width: 68.9875px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 29px;"><td style="width: 141px; height: 29px;">enable</td><td style="width: 67.9875px; height: 29px;">boolean</td><td style="width: 264.975px; height: 29px;">Enabling/disabling of an individual signal

</td><td style="width: 87.9875px; height: 29px;">No</td><td style="width: 99.9875px; height: 29px;">1</td><td style="width: 68.9875px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1</td></tr><tr style="height: 35px;"><td style="width: 141px; height: 35px;">log

</td><td style="width: 67.9875px; height: 35px;">integer</td><td style="width: 264.975px; height: 35px;">Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged

</td><td style="width: 87.9875px; height: 35px;">No</td><td style="width: 99.9875px; height: 35px;">0</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 141px; height: 35px;">gi</td><td style="width: 67.9875px; height: 35px;">boolean</td><td style="width: 264.975px; height: 35px;">Including/excluding (1 or 0) signal from General Interrogation</td><td style="width: 87.9875px; height: 35px;">No</td><td style="width: 99.9875px; height: 35px;">0</td><td style="width: 68.9875px; height: 35px;">0</td><td style="width: 69px; height: 35px;">1</td></tr><tr style="height: 35px;"><td style="width: 141px; height: 35px;">common\_address</td><td style="width: 67.9875px; height: 35px;">integer</td><td style="width: 264.975px; height: 35px;">Address of a destination device</td><td style="width: 87.9875px; height: 35px;">Yes</td><td style="width: 99.9875px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 141px; height: 29px;">function</td><td style="width: 67.9875px; height: 29px;">integer</td><td style="width: 264.975px; height: 29px;">Function number</td><td style="width: 87.9875px; height: 29px;">No</td><td style="width: 99.9875px; height: 29px;">0</td><td style="width: 68.9875px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 141px; height: 29px;">info\_address</td><td style="width: 67.9875px; height: 29px;">integer</td><td style="width: 264.975px; height: 29px;">Information object address</td><td style="width: 87.9875px; height: 29px;">Yes</td><td style="width: 99.9875px; height: 29px;">  
</td><td style="width: 68.9875px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 141px; height: 29px;">data\_type</td><td style="width: 67.9875px; height: 29px;">integer</td><td style="width: 264.975px; height: 29px;">ASDU type identifier</td><td style="width: 87.9875px; height: 29px;">Yes</td><td style="width: 99.9875px; height: 29px;">  
</td><td colspan="2" style="height: 29px; width: 137.988px;"><div><div>1, 3, 5, 9, 11, 13, 21, 30, 31, 32, 34, 35, 36, 45, 46, 47, 48, 49, 50, 58, 59, 60, 61, 62, 63</div></div></td></tr><tr><td style="width: 141px;">select\_ms</td><td style="width: 67.9875px;">integer</td><td style="width: 264.975px;">Time limit in milliseconds for command  
execution. Command select has to be  
performed before execution if this parameter is specified. Direct command execution can be performed only if this field is left empty or set to zero.</td><td style="width: 87.9875px;">No</td><td style="width: 99.9875px;">0</td><td style="width: 68.9875px;">  
</td><td style="width: 69px;">  
</td></tr></tbody></table>

##### Device status signals

<div class="pointer-container" id="bkmrk-%C2%A0-0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk-" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>IEC 60870-­5-­104 has an additional signal which can be configured to show communication status. It is used to indicate if the slave device has disconnected from master (WCC Lite). To configure such signal for IEC 60870-­5-­104 protocol, job\_todo and tag\_job\_todo fields with string values are required. For IEC 60870-­5-­104 master required parameters for status signal will be: **signal\_name** **device\_alias, signal\_alias, common\_address, info\_address, data\_type, job\_todo** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

### Debugging an IEC 60870-5-104 Master application

If the configuration for IEC 60870-5-104 devices is set up, the handler for the protocol will start automatically. If a configuration is missing parameters or contains errors, the protocol will not start. It is done intentionally to decrease unnecessary memory usage.

If IEC 60870-5-104 does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from the command-line interface and find out why the link is not functioning properly or use WCC Utility to do that.

To launch a debugging session, a user should stop the *iec104-master* process and run the *iec104-master* command with respective flags.

- Step 1: Service must be stopped by entering the following command into the WCC Lite:  
    **/etc/init.d/iec104-­master stop**
- Step 2: After service is stopped it must be started with the preferred configuration file (JSON  
    files found in /etc/ folder) and a debug level 7: **iec104-­master ­-c /etc/iec104-master/iec104-­master.json -­d7**
- Step 3: Once the problem is diagnosed normal operations can be resumed with the following command: **/etc/init.d/iec104-­master start**

##### IEC 60870-­5­-104 command-line debugging options

```
-h [ –help ] Display help information 
-V [ –version ] Show version
-d<debug level> Set debugging level 
-c [ –config ] Config path
-r [ –raw ] Show raw telegram data
-f [ –frame ] Show frame data<br></br>­-e [ –redis ] Show redis message
-R [ –readyfile ] Ready notification file
```

# 14.6 IEC 60870-5-104 Slave

<p class="callout info">Since firmware version 1.8.3, multiple signals with different data types can have same ioa address.</p>

IEC 60870-5-104 Slave is designed not to lose data acquired from Master protocols. The data that arrives from Master protocols is stored in the cache. This data is checked every second to manage further data sending. The data that leaves IEC 60870-5-104 Slave has output caches. They’re built to provide switching between multiple sessions (redundant SCADA). If a new connection arrives, the old one is dropped, but data, that is stored in a cache, not sent and not confirmed by SCADA is transferred to the new connection.

#### Configuring IEC 104 Slave datapoints

To use IEC 60870-­5­-104 Slave in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in ­Devices and Signals.

##### IEC 60870-­5-­104 Slave parameters for *Devices* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 1072.06px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 113px; width: 163px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 76px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 235px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 62px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35.3906px;"><td style="width: 163px; height: 35.3906px;">name

</td><td style="width: 76px; height: 35.3906px;">string</td><td style="width: 235px; height: 35.3906px;">User-friendly name for a device

</td><td style="width: 79px; height: 35.3906px;">Yes</td><td style="width: 109px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 163px; height: 35.3906px;">description

</td><td style="width: 76px; height: 35.3906px;">string</td><td style="width: 235px; height: 35.3906px;">Description of a device

</td><td style="width: 79px; height: 35.3906px;">No</td><td style="width: 109px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 163px; height: 35.3906px;">device\_alias

</td><td style="width: 76px; height: 35.3906px;">string</td><td style="width: 235px; height: 35.3906px;">Alphanumeric string to identify a device

</td><td style="width: 79px; height: 35.3906px;">Yes</td><td style="width: 109px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td></tr><tr style="height: 49px;"><td style="width: 163px; height: 49px;">enable</td><td style="width: 76px; height: 49px;">boolean</td><td style="width: 235px; height: 49px;">Enabling/disabling of a device

</td><td style="width: 79px; height: 49px;">No</td><td style="width: 109px; height: 49px;">1</td><td style="width: 69px; height: 49px;">0</td><td style="width: 69px; height: 49px;">1</td></tr><tr style="height: 49.5938px;"><td style="width: 163px; height: 49.5938px;">protocol</td><td style="width: 76px; height: 49.5938px;">string</td><td style="width: 235px; height: 49.5938px;">Protocol to be used

</td><td style="width: 79px; height: 49.5938px;">Yes</td><td style="width: 109px; height: 49.5938px;">  
</td><td colspan="2" style="width: 138px; height: 49.5938px;">IEC 60870­-5-104 slave</td></tr><tr style="height: 29.7969px;"><td style="width: 163px; height: 29.7969px;">asdu\_size</td><td style="width: 76px; height: 29.7969px;">integer</td><td style="width: 235px; height: 29.7969px;">Common address size in bytes</td><td style="width: 79px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">2</td><td style="width: 69px; height: 29.7969px;">1</td><td style="width: 69px; height: 29.7969px;">2</td></tr><tr style="height: 46.5938px;"><td style="width: 163px; height: 46.5938px;">time\_sync</td><td style="width: 76px; height: 46.5938px;">boolean</td><td style="width: 235px; height: 46.5938px;">Enable/disable (1 or 0) time synchronization</td><td style="width: 79px; height: 46.5938px;">Yes</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 10px;"><td style="width: 163px; height: 10px;">port</td><td style="width: 76px; height: 10px;">integer</td><td style="width: 235px; height: 10px;">TCP port</td><td style="width: 79px; height: 10px;">No</td><td style="width: 109px; height: 10px;">2404</td><td style="height: 10px; width: 69px;">0</td><td style="width: 69px; height: 10px;">65535</td></tr><tr style="height: 46.5938px;"><td style="width: 163px; height: 46.5938px;">ioa\_size</td><td style="width: 76px; height: 46.5938px;">integer</td><td style="width: 235px; height: 46.5938px;">Information object address (IOA) size in bytes</td><td style="width: 79px; height: 46.5938px;">No</td><td style="width: 109px; height: 46.5938px;">3</td><td style="width: 69px; height: 46.5938px;">1</td><td style="width: 69px; height: 46.5938px;">3</td></tr><tr style="height: 29.7969px;"><td style="width: 163px; height: 29.7969px;">swt</td><td style="width: 76px; height: 29.7969px;">integer</td><td style="width: 235px; height: 29.7969px;">Send window (SWT)</td><td style="width: 79px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">12</td><td style="width: 69px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 163px; height: 29.7969px;">rwt</td><td style="width: 76px; height: 29.7969px;">integer</td><td style="width: 235px; height: 29.7969px;">Receive window (RWT)</td><td style="width: 79px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">8</td><td style="width: 69px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 163px; height: 29.7969px;">cot\_size</td><td style="width: 76px; height: 29.7969px;">integer</td><td style="width: 235px; height: 29.7969px;">Cause of transmission (COT) size in bytes</td><td style="width: 79px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">2</td><td style="width: 69px; height: 29.7969px;">1</td><td style="width: 69px; height: 29.7969px;">3</td></tr><tr style="height: 46.5938px;"><td style="width: 163px; height: 46.5938px;">host</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 235px; height: 46.5938px;">Space-separated remote host IP addresses (ipv4)</td><td style="width: 79px; height: 46.5938px;">Yes</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 163px; height: 29.7969px;">bind\_address</td><td style="width: 76px; height: 29.7969px;">string</td><td style="width: 235px; height: 29.7969px;">Bind to local IP address (ipv4)</td><td style="width: 79px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">0.0.0.0</td><td style="width: 69px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 163px; height: 35.3906px;">t1

</td><td style="width: 76px; height: 35.3906px;">integer</td><td style="width: 235px; height: 35.3906px;">Acknowledge timeout t1 (sec)</td><td style="width: 79px; height: 35.3906px;">Yes</td><td style="width: 109px; height: 35.3906px;">15</td><td style="width: 69px; height: 35.3906px;">1</td><td style="width: 69px; height: 35.3906px;">255</td></tr><tr style="height: 57.7812px;"><td style="width: 163px; height: 57.7812px;">t2</td><td style="width: 76px; height: 57.7812px;">integer</td><td style="width: 235px; height: 57.7812px;">Connection ACKRSN clock t2 (sec),

t2 should be less than t1

</td><td style="width: 79px; height: 57.7812px;">Yes</td><td style="width: 109px; height: 57.7812px;">10</td><td style="width: 69px; height: 57.7812px;">1</td><td style="width: 69px; height: 57.7812px;">254</td></tr><tr style="height: 40px;"><td style="width: 163px; height: 40px;">t3</td><td style="width: 76px; height: 40px;">integer</td><td style="width: 235px; height: 40px;">Connection TESTFR clock t3 (sec)</td><td style="width: 79px; height: 40px;">Yes</td><td style="width: 109px; height: 40px;">20</td><td style="width: 69px; height: 40px;">1</td><td style="width: 69px; height: 40px;">172800</td></tr><tr style="height: 29.7969px;"><td style="width: 163px; height: 29.7969px;">message\_size</td><td style="width: 76px; height: 29.7969px;">boolean</td><td style="width: 235px; height: 29.7969px;">The maximum length of a message</td><td style="width: 79px; height: 29.7969px;">Yes</td><td style="width: 109px; height: 29.7969px;">253</td><td style="width: 69px; height: 29.7969px;">0</td><td style="width: 69px; height: 29.7969px;">255</td></tr><tr style="height: 29.7969px;"><td style="width: 163px; height: 29.7969px;">cache\_size</td><td style="width: 76px; height: 29.7969px;">integer</td><td style="width: 235px; height: 29.7969px;">Amount of data to be cached</td><td style="width: 79px; height: 29.7969px;">Yes</td><td style="width: 109px; height: 29.7969px;">100</td><td style="width: 69px; height: 29.7969px;">0</td><td style="width: 69px; height: 29.7969px;">1000</td></tr><tr style="height: 29.7969px;"><td style="width: 163px; height: 29.7969px;">tls</td><td style="width: 76px; height: 29.7969px;">boolean</td><td style="width: 235px; height: 29.7969px;">Enable/disable the use of TLS</td><td style="width: 79px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">0</td><td style="width: 69px; height: 29.7969px;">0</td><td style="width: 69px; height: 29.7969px;">1</td></tr><tr style="height: 46.5938px;"><td style="width: 163px; height: 46.5938px;">tls\_local\_certificate</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 235px; height: 46.5938px;">Local certificate for TLS connection</td><td style="width: 79px; height: 46.5938px;">Yes (for TLS)</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 163px; height: 46.5938px;">tls\_peer\_certificate</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 235px; height: 46.5938px;">Certificate authority file for TLS connection</td><td style="width: 79px; height: 46.5938px;">No</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 163px; height: 46.5938px;">tls\_private\_key</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 235px; height: 46.5938px;">A file consisting of the private key for TLS connection</td><td style="width: 79px; height: 46.5938px;">No</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 163px; height: 46.5938px;">command\_timeout\_ms</td><td style="width: 76px; height: 46.5938px;">integer</td><td style="width: 235px; height: 46.5938px;">Time to execute a command before responding negatively.</td><td style="width: 79px; height: 46.5938px;">No</td><td style="width: 109px; height: 46.5938px;">30000</td><td style="width: 69px; height: 46.5938px;">0</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 163px; height: 46.5938px;">command\_age\_ms</td><td style="width: 76px; height: 46.5938px;">integer</td><td style="width: 235px; height: 46.5938px;">The amount of time shift allowed for the command to still be executed.</td><td style="width: 79px; height: 46.5938px;">No</td><td style="width: 109px; height: 46.5938px;">0</td><td style="width: 69px; height: 46.5938px;">0</td><td style="width: 69px; height: 46.5938px;">  
</td></tr></tbody></table>

##### IEC 60870­-5­-104 Slave parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 136px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 77px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 261px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 89px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 99px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 136px; height: 35px;">signal\_name

</td><td style="width: 77px; height: 35px;">string</td><td style="width: 261px; height: 35px;">User-friendly signal name

</td><td style="width: 89px; height: 35px;">Yes</td><td style="width: 99px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 136px; height: 10px;">device\_alias

</td><td style="width: 77px; height: 10px;">string</td><td style="width: 261px; height: 10px;">Alphanumeric string to identify a device

</td><td style="width: 89px; height: 10px;">Yes</td><td style="width: 99px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 35px;"><td style="width: 136px; height: 35px;">signal\_alias

</td><td style="width: 77px; height: 35px;">string</td><td style="width: 261px; height: 35px;">Unique alphanumeric name of the signal to be Yes used

</td><td style="width: 89px; height: 35px;">Yes</td><td style="width: 99px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 49px;"><td style="width: 136px; height: 10px;">source\_device\_alias

</td><td style="width: 77px; height: 10px;">string</td><td style="width: 261px; height: 10px;">device\_alias of a source device

</td><td style="width: 89px; height: 10px;">For commands</td><td style="width: 99px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 49px;"><td style="width: 136px; height: 10px;">source\_signal\_alias

</td><td style="width: 77px; height: 10px;">string</td><td style="width: 261px; height: 10px;">signal\_alias of a source signal

</td><td style="width: 89px; height: 10px;">For  
commands</td><td style="width: 99px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 29px;"><td style="width: 136px; height: 29px;">enable</td><td style="width: 77px; height: 29px;">boolean</td><td style="width: 261px; height: 29px;">Enabling/disabling of an individual signal

</td><td style="width: 89px; height: 29px;">No</td><td style="width: 99px; height: 29px;">1</td><td style="width: 69px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1</td></tr><tr style="height: 35px;"><td style="width: 136px; height: 35px;">log

</td><td style="width: 77px; height: 35px;">integer</td><td style="width: 261px; height: 35px;">Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged

</td><td style="width: 89px; height: 35px;">No</td><td style="width: 99px; height: 35px;">0</td><td style="width: 69px; height: 35px;">0</td><td style="width: 69px; height: 35px;">1</td></tr><tr style="height: 35px;"><td style="width: 136px; height: 35px;">gi</td><td style="width: 77px; height: 35px;">boolean</td><td style="width: 261px; height: 35px;">Including/excluding (1 or 0) signal from General Interrogation</td><td style="width: 89px; height: 35px;">No</td><td style="width: 99px; height: 35px;">0</td><td style="width: 69px; height: 35px;">0</td><td style="width: 69px; height: 35px;">1</td></tr><tr style="height: 35px;"><td style="width: 136px; height: 35px;">common\_address</td><td style="width: 77px; height: 35px;">integer</td><td style="width: 261px; height: 35px;">Address of a destination device</td><td style="width: 89px; height: 35px;">Yes</td><td style="width: 99px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 136px; height: 29px;">info\_address</td><td style="width: 77px; height: 29px;">integer</td><td style="width: 261px; height: 29px;">Information object address</td><td style="width: 89px; height: 29px;">Yes</td><td style="width: 99px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 136px; height: 29px;">data\_type</td><td style="width: 77px; height: 29px;">integer</td><td style="width: 261px; height: 29px;">ASDU type id.</td><td style="width: 89px; height: 29px;">Yes</td><td style="width: 99px; height: 29px;">  
</td><td colspan="2" style="width: 138px; height: 29px;"><div><div>1, 3, 5, 9, 11, 13, 21, 30, 31, 32, 34, 35, 36, 45, 46, 47, 48, 49, 50, 58, 59, 60, 61, 62, 63</div></div></td></tr><tr style="height: 113px;"><td style="width: 136px; height: 113px;">select\_ms</td><td style="width: 77px; height: 113px;">integer</td><td style="width: 261px; height: 113px;">Time limit in milliseconds for command  
execution. Command select has to be  
performed before execution if this parameter is specified. Direct command execution can be performed only if this field is left empty or set to zero.</td><td style="width: 89px; height: 113px;">No</td><td style="width: 99px; height: 113px;">0</td><td style="width: 69px; height: 113px;">  
</td><td style="width: 69px; height: 113px;">  
</td></tr></tbody></table>

##### Device status signals

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk-" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>IEC 60870-­5-­104 has an additional signal which can be configured to show communication status. It is used to indicate if the master device has disconnected from slave (WCC Lite). To configure such signal for IEC 60870-­5-­104 protocol, job\_todo and tag\_job\_todo fields with string values are required. For IEC 60870-­5-­104 slave required parameters for status signal will be: **signal\_name** **device\_alias, signal\_alias, common\_address, info\_address, data\_type, job\_todo** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

### Debugging an IEC 60870-5-104 Slave application

If the configuration for IEC 60870-5-104 devices is set up, the handler for the protocol will start automatically. If a configuration is missing parameters or contains errors, the protocol will not start. It is done intentionally to decrease unnecessary memory usage.

If IEC 60870-5-104 does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from the command-line interface and find out why the link is not functioning properly or use WCC Utility to do that.

To launch a debugging session, a user should stop the *iec104-slave* process and run the *iec104-slave* command with respective flags.

- Step 1: Service must be stopped by entering the following command into the WCC Lite:  
    **/etc/init.d/iec104-­slave stop**
- Step 2: After service is stopped it must be started with the preferred configuration file (JSON  
    files found in /etc/ folder) and a debug level 7: **iec104-­slave­-c /etc/iec104-slave/0\_0\_0\_0\_502.json -­d7;** (0\_0\_0\_0 - bind\_address, 502 - port)
- Step 3: Once the problem is diagnosed normal operations can be resumed with the following command: **/etc/init.d/iec107-­slave start**

##### IEC 60870-­5­-104 command-line debugging options

```
-h [ –help ] Display help information 
-V [ –version ] Show version
-d<debug level> Set debugging level 
-c [ –config ] Config path
-r [ –raw ] Show raw telegram data
-f [ –frame ] Show frame data<br></br>­-e [ –redis ] Show redis message
-R [ –readyfile ] Ready notification file
```

# 15 IEC 61850



# 15.1 Introduction

IEC 61850 is an international standard defining communication protocols for intelligent electronic devices at electrical substations. It is a part of the International Electrotechnical Commission’s (IEC) Technical Committee 57 reference architecture for electric power systems. The abstract data models defined in IEC 61850 can be mapped to a number of protocols. Possible mappings in the standard can be MMS (Manufacturing Message Specification), GOOSE (Generic Object Oriented Substation Event), SMV (Sampled Measured Values). These protocols can run over TCP/IP networks or substation LANs using high speed switched Ethernet to obtain the necessary response times below four milliseconds for protective relaying.

<p class="callout success">As of version v1.5.0, WCC Lite supports MMS type messaging. Logging and groups setting services are not supported.</p>

# 15.2 IEC 61850 Server

WCC Lite can act as an IEC 61850 server to serve data to remote SCADA systems. For example, WCC Lite can be used to acquire data from various protocols (Modbus, IEC 60870-5-103, etc.), this data can be redirected and propagated further to a single or multiple IEC 61850 clients. IEC 61850 Server supports TCP and TLS connection types. TCP connection can be secured with password authentication.

#### Commands

WCC Lite **IEC 61850 Server** implementation defines four command types which are described by their control model:

- **Case 1**: Direct control with normal security (direct-operate);
- **Case 2**: SBO control with normal security (operate-once or operate-many);
- **Case 3**: Direct control with enhanced security (direct-operate);
- **Case 4**: SBO control with enhanced security (operate-once or operate-many).

Normal security commands are considered for execution if the command signal is found in Excel configuration. There aren’t any additional checks in command execution in any master protocol.

Enhanced security commands need feedback from the master protocol to either succeed or fail. If feedback is not received within the **command\_ack\_timeout\_ms** timeframe, the command is considered as failed.

Command value attributes (e.g. stVal) must be updated separately (if they need to be updated).

<p class="callout info">When using SBO commands, select is not routed to the master protocol, and select logic is performed only in the IEC 61850 Server protocol.</p>

#### Configuring data points

To use the IEC 61850 Server in WCC Lite, it has to be configured via an Excel configuration, and the data model must be uploaded. This configuration contains two Excel sheets where parameters have to be filled in - Devices and Signals.

If a few devices were to connect to a server using the same virtual port, all of the IP addresses have to be specified on the host field separated by space. That way all of the clients will be able to connect from different IP addresses but using the same port as long as they all have the same subnet address.

##### IEC 61850 Server parameters for Devices tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 1085.59px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 113px; width: 185px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 76px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 196px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 96px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 62px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35.3906px;"><td style="width: 185px; height: 35.3906px;">name

</td><td style="width: 76px; height: 35.3906px;">string</td><td style="width: 196px; height: 35.3906px;">User-friendly name for a device</td><td style="width: 96px; height: 35.3906px;">Yes</td><td style="width: 109px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 185px; height: 29.7969px;">description</td><td style="width: 76px; height: 29.7969px;">string</td><td style="width: 196px; height: 29.7969px;">Description of a device</td><td style="width: 96px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 185px; height: 46.5938px;">device\_alias</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 196px; height: 46.5938px;">Alphanumeric string to identify a device</td><td style="width: 96px; height: 46.5938px;">Yes</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 185px; height: 29.7969px;">enable</td><td style="width: 76px; height: 29.7969px;">boolean</td><td style="width: 196px; height: 29.7969px;">Enabling/disabling of a device</td><td style="width: 96px; height: 29.7969px;">No</td><td style="width: 109px; height: 29.7969px;">1</td><td style="width: 69px; height: 29.7969px;">0</td><td style="width: 69px; height: 29.7969px;">1</td></tr><tr style="height: 29.7969px;"><td style="width: 185px; height: 29.7969px;">protocol</td><td style="width: 76px; height: 29.7969px;">string</td><td style="width: 196px; height: 29.7969px;">Protocol to be used</td><td style="width: 96px; height: 29.7969px;">Yes</td><td style="width: 109px; height: 29.7969px;">  
</td><td colspan="2" style="width: 138px; height: 29.7969px;">IEC 61850 Server</td></tr><tr style="height: 63.3906px;"><td style="width: 185px; height: 63.3906px;">bind\_address</td><td style="width: 76px; height: 63.3906px;">string (IP address format)</td><td style="width: 196px; height: 63.3906px;">The IP address of an interface to use with the server</td><td style="width: 96px; height: 63.3906px;">No</td><td style="width: 109px; height: 63.3906px;">0.0.0.0</td><td colspan="2" style="width: 138px; height: 63.3906px;">  
</td></tr><tr style="height: 66.3906px;"><td style="width: 185px; height: 66.3906px;">host</td><td style="width: 76px; height: 66.3906px;">string (IP address format)</td><td style="width: 196px; height: 66.3906px;">IP address list of allowed IPs (separated with spaces)

</td><td style="width: 96px; height: 66.3906px;">Yes</td><td style="width: 109px; height: 66.3906px;">  
</td><td style="width: 69px; height: 66.3906px;">  
</td><td style="width: 69px; height: 66.3906px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 185px; height: 35.3906px;">port</td><td style="width: 76px; height: 35.3906px;">integer</td><td style="width: 196px; height: 35.3906px;">TCP communication port

</td><td style="width: 96px; height: 35.3906px;">No</td><td style="width: 109px; height: 35.3906px;">102</td><td style="width: 69px; height: 35.3906px;">  
</td><td style="width: 69px; height: 35.3906px;">  
</td></tr><tr style="height: 66.3906px;"><td style="width: 185px; height: 66.3906px;">auth</td><td style="width: 76px; height: 66.3906px;">string</td><td style="width: 196px; height: 66.3906px;">Authorization type

</td><td style="width: 96px; height: 66.3906px;">Yes</td><td style="width: 109px; height: 66.3906px;">  
</td><td colspan="2" style="width: 138px; height: 66.3906px;">“NONE”, “PASSWORD”, “TLS”</td></tr><tr style="height: 57.7812px;"><td style="width: 185px; height: 57.7812px;">password</td><td style="width: 76px; height: 57.7812px;">string</td><td style="width: 196px; height: 57.7812px;">Authorization password for server device

</td><td style="width: 96px; height: 57.7812px;">Yes ( for PASSWORD)</td><td style="width: 109px; height: 57.7812px;">  
</td><td colspan="2" style="width: 138px; height: 57.7812px;">  
</td></tr><tr style="height: 49.5938px;"><td style="width: 185px; height: 49.5938px;">tls\_local\_certificate</td><td style="width: 76px; height: 49.5938px;">string</td><td style="width: 196px; height: 49.5938px;">Local certificate for TLS connection

</td><td style="width: 96px; height: 49.5938px;">Yes (for TLS)</td><td style="width: 109px; height: 49.5938px;">  
</td><td colspan="2" style="width: 138px; height: 49.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 185px; height: 46.5938px;">tls\_peer\_certificate</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 196px; height: 46.5938px;">Certificate authority file for TLS connection</td><td style="width: 96px; height: 46.5938px;">Yes (for TLS)</td><td style="width: 109px; height: 46.5938px;">  
</td><td colspan="2" style="width: 138px; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 185px; height: 46.5938px;">tls\_private\_key</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 196px; height: 46.5938px;">A file consisting of the private key for TLS connection</td><td style="width: 96px; height: 46.5938px;">Yes (for TLS)</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 185px; height: 46.5938px;">ied\_name</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 196px; height: 46.5938px;">Name of an Intelligent Electronic Device</td><td style="width: 96px; height: 46.5938px;">Yes</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr><td style="width: 185px;">originator</td><td style="width: 76px;">string</td><td style="width: 196px;">Origin identification for the device</td><td style="width: 96px;">No</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 185px; height: 46.5938px;">model\_filename</td><td style="width: 76px; height: 46.5938px;">string</td><td style="width: 196px; height: 46.5938px;">The filename of the server model, without the .server extension</td><td style="width: 96px; height: 46.5938px;">Yes</td><td style="width: 109px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 102.562px;"><td style="width: 185px; height: 102.562px;">command\_ack\_timeout\_ms

</td><td style="width: 76px; height: 102.562px;">integer</td><td style="width: 196px; height: 102.562px;">Timeframe (ms) in which enhanced-security commands must be acknowledged

(Default: 3000)

</td><td style="width: 96px; height: 102.562px;">No</td><td style="width: 109px; height: 102.562px;">3000</td><td style="width: 69px; height: 102.562px;">  
</td><td style="width: 69px; height: 102.562px;">  
</td></tr><tr style="height: 80.1719px;"><td style="width: 185px; height: 80.1719px;">report\_buffered\_size</td><td style="width: 76px; height: 80.1719px;">integer</td><td style="width: 196px; height: 80.1719px;">Report control blocks buffer size in bytes

(Default: 65536)

</td><td style="width: 96px; height: 80.1719px;">No</td><td style="width: 109px; height: 80.1719px;">65536</td><td style="width: 69px; height: 80.1719px;">  
</td><td style="width: 69px; height: 80.1719px;">  
</td></tr><tr style="height: 57.7812px;"><td style="width: 185px; height: 57.7812px;">report\_unbuffered\_size</td><td style="width: 76px; height: 57.7812px;">integer</td><td style="width: 196px; height: 57.7812px;">Unbuffered report control blocks buffer size in bytes (Default: 65513)

</td><td style="width: 96px; height: 57.7812px;">No</td><td style="width: 109px; height: 57.7812px;">65513</td><td style="width: 69px; height: 57.7812px;">  
</td><td style="width: 69px; height: 57.7812px;">  
</td></tr></tbody></table>

##### IEC 61850 Server parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 938.735px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 113px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 71.9875px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 271.975px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 91.988px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 95.9875px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 62px; width: 137.988px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9875px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">signal\_name</td><td style="width: 71.9875px; height: 29.7969px;">string</td><td style="width: 271.975px; height: 29.7969px;">User-friendly signal name</td><td style="width: 91.988px; height: 29.7969px;">Yes</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td style="width: 68.9875px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">device\_alias</td><td style="width: 71.9875px; height: 29.7969px;">string</td><td style="width: 271.975px; height: 29.7969px;">Device alias from a Devices tab</td><td style="width: 91.988px; height: 29.7969px;">Yes</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td style="width: 68.9875px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 130px; height: 46.5938px;">signal\_alias</td><td style="width: 71.9875px; height: 46.5938px;">string</td><td style="width: 271.975px; height: 46.5938px;">Unique alphanumeric name of the signal to be used</td><td style="width: 91.988px; height: 46.5938px;">Yes</td><td style="width: 95.9875px; height: 46.5938px;">  
</td><td style="width: 68.9875px; height: 46.5938px;">  
</td><td style="width: 69px; height: 46.5938px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">enable</td><td style="width: 71.9875px; height: 29.7969px;">boolean</td><td style="width: 271.975px; height: 29.7969px;">Enabling/disabling of an individual signal</td><td style="width: 91.988px; height: 29.7969px;">No</td><td style="width: 95.9875px; height: 29.7969px;">1</td><td style="width: 68.9875px; height: 29.7969px;">0</td><td style="width: 69px; height: 29.7969px;">1</td></tr><tr style="height: 63.3906px;"><td style="width: 130px; height: 63.3906px;">log</td><td style="width: 71.9875px; height: 63.3906px;">boolean</td><td style="width: 271.975px; height: 63.3906px;">Allow signal to be logged. If the **log is 0 signal** will not be logged. If the **log is more than 0** signal will be logged</td><td style="width: 91.988px; height: 63.3906px;">No</td><td style="width: 95.9875px; height: 63.3906px;">0</td><td style="width: 68.9875px; height: 63.3906px;">  
</td><td style="width: 69px; height: 63.3906px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 130px; height: 46.5938px;">number\_type</td><td style="width: 71.9875px; height: 46.5938px;">string</td><td style="width: 271.975px; height: 46.5938px;">Number format type (BOOLEAN, FLOAT, INT16, etc.)</td><td style="width: 91.988px; height: 46.5938px;">Yes</td><td style="width: 95.9875px; height: 46.5938px;">  
</td><td colspan="2" style="height: 46.5938px; width: 137.988px;">BOOLEAN, INT8, INT16, INT32, INT64, INT128, INT8U, INT24U, INT32U, FLOAT32, FLOAT64, ENUMERATED, OCTET STRING 64, OCTET STRING 6, OCTET STRING 8, VISIBLE STRING 32, VISIBLE STRING 64, VISIBLE STRING 65, VISIBLE STRING 129, VISIBLE STRING 255, UNICODE STRING 255, TIMESTAMP, QUALITY, CHECK, CODEDENUM, GENERIC BITSTRING, CONSTRUCTED, ENTRY TIME, PHYCOMADDR, CURRENCY, OPTFLDS, TRGOPS</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">ld\_instance</td><td style="width: 71.9875px; height: 29.7969px;">string</td><td style="width: 271.975px; height: 29.7969px;">An instance of a logical device</td><td style="width: 91.988px; height: 29.7969px;">Yes</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td style="width: 68.9875px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">ln\_class</td><td style="width: 71.9875px; height: 29.7969px;">string</td><td style="width: 271.975px; height: 29.7969px;">Logical node class type</td><td style="width: 91.988px; height: 29.7969px;">Yes</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td style="width: 68.9875px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">ln\_instance</td><td style="width: 71.9875px; height: 29.7969px;">integer</td><td style="width: 271.975px; height: 29.7969px;">An instance of a logical node </td><td style="width: 91.988px; height: 29.7969px;">No</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td style="width: 68.9875px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">ln\_prefix</td><td style="width: 71.9875px; height: 29.7969px;">string</td><td style="width: 271.975px; height: 29.7969px;">Prefix of logical node string</td><td style="width: 91.988px; height: 29.7969px;">No</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td style="width: 68.9875px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 97px;"><td style="width: 130px; height: 97px;">cdc</td><td style="width: 71.9875px; height: 97px;">string</td><td style="width: 271.975px; height: 97px;">Common Data Class (CDC) name</td><td style="width: 91.988px; height: 97px;">Yes</td><td style="width: 95.9875px; height: 97px;">  
</td><td colspan="2" style="width: 137.988px; height: 97px;">SPS, DPS, INS, ENS, ACT, ACD, MV, CMV, SAV, SPC, DPC, INC, ENC, BSC, ISC, APC, BAC</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">data\_object</td><td style="width: 71.9875px; height: 29.7969px;">string</td><td style="width: 271.975px; height: 29.7969px;">Name of a data object in the dataset</td><td style="width: 91.988px; height: 29.7969px;">Yes</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td style="width: 68.9875px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">da\_value</td><td style="width: 71.9875px; height: 29.7969px;">string</td><td style="width: 271.975px; height: 29.7969px;">Name of a data attribute value node</td><td style="width: 91.988px; height: 29.7969px;">Yes</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td style="width: 68.9875px; height: 29.7969px;">  
</td><td style="width: 69px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">da\_fc</td><td style="width: 71.9875px; height: 29.7969px;">string</td><td style="width: 271.975px; height: 29.7969px;">Functional constrain for data object</td><td style="width: 91.988px; height: 29.7969px;">Yes</td><td style="width: 95.9875px; height: 29.7969px;">  
</td><td colspan="2" style="width: 137.988px; height: 29.7969px;">ST, MX, CO, SP</td></tr><tr style="height: 214.594px;"><td style="width: 130px; height: 214.594px;">control\_model</td><td style="width: 71.9875px; height: 214.594px;">string

</td><td style="width: 271.975px; height: 214.594px;">Model of output control

</td><td style="width: 91.988px; height: 214.594px;">Yes (for commands)

</td><td style="width: 95.9875px; height: 214.594px;">read-only</td><td colspan="2" style="width: 137.988px; height: 214.594px;">read-only,

direct-with-normal-security,

sbo-with-normal-security,

direct-with-enhanced-security, sbo-with-enhanced-security

</td></tr></tbody></table>

##### Device status signals

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk--1" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>IEC 61850 has an additional signal which can be configured to show communication status. It is used to indicate if the client device has disconnected from the server (WCC Lite). To configure such a signal for the IEC 61850 protocol, job\_todo and tag\_job\_todo fields with string values are required. For the IEC 61850 server required parameters for the status signal will be **signal\_name** **device\_alias, signal\_alias, number\_type, job\_todo,** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and is based on the same logic. If the signal returns the value of 0, it means an unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

#### Converting and uploading data model

To use the IEC61850 Server protocol in WCC Lite, the user must upload a data model in a specific format (file extension .server). These data models can be converted from SCL files (.icd, .cid, or .scd files). To convert a data model, the user must use WCC Excel Utility. There’s a separate tab for this operation as shown in the picture below.

[![image-1670582144161.png](https://wiki.elseta.com/uploads/images/gallery/2022-12/scaled-1680-/image-1670582144161.png)](https://wiki.elseta.com/uploads/images/gallery/2022-12/image-1670582144161.png)

The converted file can be uploaded in the WCC Lite web interface, Protocol Hub section. The current model can be also downloaded on the same page as shown in the picture below.

[![image-1670583136986.png](https://wiki.elseta.com/uploads/images/gallery/2022-12/scaled-1680-/image-1670583136986.png)](https://wiki.elseta.com/uploads/images/gallery/2022-12/image-1670583136986.png)

#### Debugging an IEC 61850 server application

If the configuration for the IEC 61850 Server is set up, a handler for the protocol will start automatically. If the configuration is missing or contains errors, the protocol will not start. It is done intentionally to decrease unnecessary memory usage.

<p class="callout warning">If the IEC 61850 Server does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from the command line interface and find out why the link is not functioning properly.</p>

<p class="callout info">To launch a debugging session, a user should stop `iec61850-server` process and run` iec61850-server` command with respective flags as you can see below:</p>

```
iec61850-server
```

```iec61850-server
-h [--help] Show help message
-c [--config] arg Configuration file location
-V [--version] Show version
-d [--debug] arg Set Debug level
-r [--redis] Show Redis messages
-C [--commands] Show command messages
-R [--readyfile] arg Ready notification file
```

# 15.3 IEC 61850 Client

WCC Lite can be used as a master station to collect data from IEC 61850 compatible server devices such as protection relays. As relays require fast, secure and responsive interfaces, WCC Lite can be considered as a valid option. For additional security a user can use encrypted transmission (TLS) or set up a password.

<p class="callout info">As TCP (TLS) connection can encounter issues and break, automatic reconnection is implemented. After every failed reconnection attempt the fallback delay is doubled starting from 1 second up until 32 seconds. After that connection reestablishment will be attempted every 32 seconds until a successful connection.</p>

#### Acquiring data via report control blocks

As per IEC 61850 standard, the report control block controls the procedures that are required for reporting values of data objects from one or more logical nodes to one client. Automatic reporting enables data servers (slave devices) to only send data on its (or its quality) change, thus saving network bandwidth. Instances of report control blocks are configured in the server at configuration time.

Report control blocks send information that is defined in their respective datasets. Dataset is a set of data elements grouped to represent some data group. For example, it is a common practice to group measurements and events into different groups.

A server restricts access to an instance of a report control block to one client at a time. That client exclusively shall own that instance and shall receive reports from that instance of report control blocks. There are two classes of report control blocks defined, each with a slightly different behavior:

- buffered-report-control-block (BRCB) - internal events (caused by trigger options data-change, quality-change, and data-update) issue immediate sending of reports or buffer the events (to some practical limit) for transmission, such that values of data object are not lost due to transport flow control constraints or loss of connection. BRCB provides the sequence-of-events (SOE) functionality;
- unbuffered-report-control-block (URCB) - internal events (caused by trigger options data-change, quality-change, and data-update) issue immediate sending of reports on a best efforts basis. If no association exists, or if the transport data flow is not fast enough to support it, events may be lost.

Buffered report control blocks are therefore useful to keep event data, for example, keeping the last known state of a relay switch where a loss of information might lead to a confusion and even financial losses. Unbuffered report control blocks are particularly useful for data which is useful only momentarily, e.g. measurements of voltages, current or power. This information can change frequently and old measurements might not reflect the real state of a substation.

To allow multiple clients to receive the same values of data object, multiple instances of the report control classes shall be made available.

Buffered report control blocks are usually configured to be used by a specific client implementing a well-defined functionality, for example, a SCADA master. The client may know the ObjectReference of the BRCB by configuration or by the use of a naming convention.

Parsing of report control blocks is based on types of Common Data Class (CDC). Some of these types can have more than one data point of interest. Table below shows what data attributes are supported from various Common Data Classes. To select which data attribute should be used a `da_value` column should be filled with a data attribute name. Common Data Classes consist of data attributes with different Functional Constraints therefore to get the status points of interest correctly the user must fill in a correct value in `da_fc` column.

IEC 61850 Client supported data attributes:

<table border="1" id="bkmrk-common-data-class-fu" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.3333%;">Common Data Class</td><td style="width: 33.3333%;">Function Constraint</td><td style="width: 33.3333%;">Data attributes</td></tr><tr><td style="width: 33.3333%;">SPS

DPS

INS

ENS

</td><td style="width: 33.3333%;">ST</td><td style="width: 33.3333%;">stVal</td></tr><tr><td style="width: 33.3333%;">ACT</td><td style="width: 33.3333%;">ST</td><td style="width: 33.3333%;">general

phsA

phsB

phsC

neut

</td></tr><tr><td style="width: 33.3333%;">ACD</td><td style="width: 33.3333%;">ST</td><td style="width: 33.3333%;">general

dirGeneral

phsA

dirPhsA

phsB

dirPhsB

phsC

dirPhsC

neut

dirNeut

</td></tr><tr><td style="width: 33.3333%;">MV</td><td style="width: 33.3333%;">MX</td><td style="width: 33.3333%;">instMag

mag

</td></tr><tr><td style="width: 33.3333%;">CMV</td><td style="width: 33.3333%;">MX</td><td style="width: 33.3333%;">instCVal

cVal

</td></tr><tr><td style="width: 33.3333%;">SAV</td><td style="width: 33.3333%;">MX</td><td style="width: 33.3333%;">instMag</td></tr><tr><td style="width: 33.3333%;">SPC

DPC

INC

ENC

</td><td style="width: 33.3333%;">ST</td><td style="width: 33.3333%;">stVal</td></tr><tr><td style="width: 33.3333%;">BSC

ISC

</td><td style="width: 33.3333%;">ST</td><td style="width: 33.3333%;">valWTr</td></tr><tr><td style="width: 33.3333%;">APC

BAC

</td><td style="width: 33.3333%;">MX</td><td style="width: 33.3333%;">mxVal</td></tr></tbody></table>

Some of data attributes are structures themselves, for example, `mag` attribute is a struct that can hold integer or float values. To select a fitting attribute the user should extend `da_value` parameter with additional attributes, for example, if float magnitude value is to be selected from MV Common Data Class, `da_value` column should be filled with `mag.f` value; if the user intends `cVal` magnitude value in float format from CMV Common Data Class, `da_value` should be filled with `cVal.mag.f` value. See IEC 61850-7-3 for more information about Common Data Classes.

To ensure the integrity of configuration, WCC Lite has additional checks implemented at configuration time. If report control block (or its dataset) with a predefined ObjectReference doesn’t exist, it is considered that IEC 61850 Client has not been configured properly or configuration has been changed in either of IEC 61850 devices and cannot be matched, therefore should be considered invalid.

<span style="font-size: 1.666em; font-weight: 400;">Controlling remote equipment via commands</span>

The control model provides a specific way to change the state of internal and external processes by a client. The control model can only be applied to data object instances of a controllable Common Data Class (CDC) and whose ctlModel DataAttribute is not set to status - only. Such data objects can be referred to as control objects. If controls are enabled in a IEC 61850 Server device the user can configure controls by filling control\_model column in Excel configuration with a control model (*direct-with-normal-security, sbo-with-normal-security, direct-with-enhanced-security, sbo-with-enhanced-security*) as well as setting functional constraint in `da_fc` column to CO.

Depending on the application, different behaviors of a control object shall be used. Therefore, different state machines are defined. Four cases are defined:

- **Case 1**: Direct control with normal security (direct-operate);
- **Case 2**: SBO control with normal security (operate-once or operate-many);
- **Case 3**: Direct control with enhanced security (direct-operate);
- **Case 4**: SBO control with enhanced security (operate-once or operate-many).

IEC 61850 standard enables the user to plan command transmission in advance - set the timer when the command should be issued. However, as this possibility is rarely used in practice, it is not implemented as of version v1.8 All issued commands are executed immediately.

For more information on control class model, please consult IEC 61850-7-2 standard.

If ctlModel is read-only, messages from internal database will be ignored for this point, otherwise a subscribe callback will be launched to handle commands as soon as they are sent. If CDC of a signal does not have means of control, ctlModel parameter is ignored.

Originator identification can be attached to a station so that replies to command requests could be forwarded to only one device. To use this functionality a user should select an origin identifier by filling value in Excel configuration, originator column. Originator category is always enforced to tell that <span style="text-decoration: underline;">remote control</span> command is issued.

#### Configuring datapoints

To use IEC 61850 Client in WCC Lite, it has to be configured via an Excel configuration. This configuration contains two Excel sheets where parameters have to be filled in - Devices and Signals tables.

##### Table IEC 61850 Client parameters for *Devices* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 741.297px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 113px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 252px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 99px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 83px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 62px; width: 164px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 82px;">Min

</td><td class="align-center" style="height: 51px; width: 82px;">Max

</td></tr><tr style="height: 35.3906px;"><td style="width: 130px; height: 35.3906px;">name

</td><td style="width: 72px; height: 35.3906px;">string</td><td style="width: 252px; height: 35.3906px;">User-friendly name for a device</td><td style="width: 99px; height: 35.3906px;">Yes</td><td style="width: 83px; height: 35.3906px;">  
</td><td style="width: 82px; height: 35.3906px;">  
</td><td style="width: 82px; height: 35.3906px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">description</td><td style="width: 72px; height: 29.7969px;">string</td><td style="width: 252px; height: 29.7969px;">Description of a device</td><td style="width: 99px; height: 29.7969px;">No</td><td style="width: 83px; height: 29.7969px;">  
</td><td style="width: 82px; height: 29.7969px;">  
</td><td style="width: 82px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">device\_alias</td><td style="width: 72px; height: 29.7969px;">string</td><td style="width: 252px; height: 29.7969px;">Alphanumeric string to identify a device</td><td style="width: 99px; height: 29.7969px;">Yes</td><td style="width: 83px; height: 29.7969px;">  
</td><td style="width: 82px; height: 29.7969px;">  
</td><td style="width: 82px; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">enable</td><td style="width: 72px; height: 29.7969px;">boolean</td><td style="width: 252px; height: 29.7969px;">Enabling/disabling of a device</td><td style="width: 99px; height: 29.7969px;">No</td><td style="width: 83px; height: 29.7969px;">1</td><td style="width: 82px; height: 29.7969px;">0</td><td style="width: 82px; height: 29.7969px;">1</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">protocol</td><td style="width: 72px; height: 29.7969px;">string</td><td style="width: 252px; height: 29.7969px;">Protocol to be used</td><td style="width: 99px; height: 29.7969px;">Yes</td><td style="width: 83px; height: 29.7969px;">  
</td><td colspan="2" style="width: 164px; height: 29.7969px;">IEC 61850 Client</td></tr><tr style="height: 66.3906px;"><td style="width: 130px; height: 66.3906px;">host</td><td style="width: 72px; height: 66.3906px;">string (IP address format)</td><td style="width: 252px; height: 66.3906px;">IP address of server device

</td><td style="width: 99px; height: 66.3906px;">Yes</td><td style="width: 83px; height: 66.3906px;">  
</td><td style="height: 66.3906px; width: 82px;">  
</td><td style="width: 82px; height: 66.3906px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 130px; height: 35.3906px;">port</td><td style="width: 72px; height: 35.3906px;">integer</td><td style="width: 252px; height: 35.3906px;">TCP communication port

</td><td style="width: 99px; height: 35.3906px;">Yes</td><td style="width: 83px; height: 35.3906px;">102</td><td style="width: 82px; height: 35.3906px;">  
</td><td style="width: 82px; height: 35.3906px;">  
</td></tr><tr><td style="width: 130px;">auth</td><td style="width: 72px;">string</td><td style="width: 252px;">Authorization type

</td><td style="width: 99px;">Yes</td><td style="width: 83px;">  
</td><td colspan="2" style="width: 164px;">none, password, tls  
</td></tr><tr><td style="width: 130px;">password</td><td style="width: 72px;">string</td><td style="width: 252px;">Authorization password for server device

</td><td style="width: 99px;">Yes (for PASSWORD)</td><td style="width: 83px;">  
</td><td colspan="2" style="width: 164px;">  
</td></tr><tr style="height: 49.5938px;"><td style="width: 130px; height: 49.5938px;">tls\_local\_certificate</td><td style="width: 72px; height: 49.5938px;">string</td><td style="width: 252px; height: 49.5938px;">Local certificate for TLS connection

</td><td style="width: 99px; height: 49.5938px;">Yes (for TLS)</td><td style="width: 83px; height: 49.5938px;">  
</td><td style="width: 82px; height: 49.5938px;">  
</td><td style="width: 82px; height: 49.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 130px; height: 46.5938px;">tls\_peer\_certificate</td><td style="width: 72px; height: 46.5938px;">string</td><td style="width: 252px; height: 46.5938px;">Certificate authority file for TLS connection</td><td style="width: 99px; height: 46.5938px;">Yes (for TLS)</td><td style="width: 83px; height: 46.5938px;">  
</td><td style="height: 46.5938px; width: 82px;">  
</td><td style="width: 82px; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 130px; height: 46.5938px;">tls\_private\_key</td><td style="width: 72px; height: 46.5938px;">string</td><td style="width: 252px; height: 46.5938px;">File consisting of private key for TLS connection</td><td style="width: 99px; height: 46.5938px;">Yes (for TLS)</td><td style="width: 83px; height: 46.5938px;">  
</td><td style="height: 46.5938px; width: 82px;">  
</td><td style="width: 82px; height: 46.5938px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 130px; height: 29.7969px;">ied\_name</td><td style="width: 72px; height: 29.7969px;">string</td><td style="width: 252px; height: 29.7969px;">Name of an Intelligent Electronic Device</td><td style="width: 99px; height: 29.7969px;">Yes</td><td style="width: 83px; height: 29.7969px;">  
</td><td style="width: 82px; height: 29.7969px;">  
</td><td style="width: 82px; height: 29.7969px;">  
</td></tr><tr style="height: 35.3906px;"><td style="width: 130px; height: 35.3906px;">originator</td><td style="width: 72px; height: 35.3906px;">string</td><td style="width: 252px; height: 35.3906px;">Origin identifier for device

</td><td style="width: 99px; height: 35.3906px;">No</td><td style="width: 83px; height: 35.3906px;">  
</td><td style="width: 82px; height: 35.3906px;">  
</td><td style="width: 82px; height: 35.3906px;">  
</td></tr><tr style="height: 57.7812px;"><td style="width: 130px; height: 57.7812px;">model\_filename</td><td style="width: 72px; height: 57.7812px;">string</td><td style="width: 252px; height: 57.7812px;">Filename of client model uploaded to WCC (must contain .client extension)

</td><td style="width: 99px; height: 57.7812px;">Yes</td><td style="width: 83px; height: 57.7812px;">  
</td><td style="width: 82px; height: 57.7812px;">  
</td><td style="width: 82px; height: 57.7812px;">  
</td></tr></tbody></table>

##### Table IEC 61850 Client parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 71.9602px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 271.989px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 78.9915px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 108.963px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.983px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9915px;">Min

</td><td class="align-center" style="height: 51px; width: 68.9915px;">Max

</td></tr><tr style="height: 10px;"><td style="width: 130px; height: 10px;">signal\_name</td><td style="width: 71.9602px; height: 10px;">string</td><td style="width: 271.989px; height: 10px;">User-friendly signal name</td><td style="width: 78.9915px; height: 10px;">Yes</td><td style="width: 108.963px; height: 10px;">  
</td><td style="width: 68.9915px; height: 10px;">  
</td><td style="width: 68.9915px; height: 10px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">device\_alias</td><td style="width: 71.9602px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Device alias from a Devices tab</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.963px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td></tr><tr style="height: 10px;"><td style="width: 130px; height: 10px;">signal\_alias</td><td style="width: 71.9602px; height: 10px;">string</td><td style="width: 271.989px; height: 10px;">Unique alphanumeric name of the signal to be used</td><td style="width: 78.9915px; height: 10px;">Yes</td><td style="width: 108.963px; height: 10px;">  
</td><td style="width: 68.9915px; height: 10px;">  
</td><td style="width: 68.9915px; height: 10px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">enable</td><td style="width: 71.9602px; height: 29px;">boolean</td><td style="width: 271.989px; height: 29px;">Enabling/disabling of an individual signal</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.963px; height: 29px;">1</td><td style="width: 68.9915px; height: 29px;">0</td><td style="width: 68.9915px; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">log</td><td style="width: 71.9602px; height: 29px;">boolean</td><td style="width: 271.989px; height: 29px;">Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.963px; height: 29px;">0</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">number\_type</td><td style="width: 71.9602px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Number format type </td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.963px; height: 29px;">  
</td><td colspan="2" style="height: 29px; width: 137.983px;"><div><div>BOOLEAN, INT8, INT16, INT32, INT64, INT128, INT8U, INT24U, INT32U, FLOAT32, FLOAT64, ENUMERATED, OCTETSTRING6, OCTETSTRING8, OCTETSTRING64, VISIBLESTRING32, VISIBLESTRING64, VISIBLESTRING65, VISIBLESTRING129, VISIBLESTRING255, UNICODESTRING255, TIMESTAMP, QUALITY, CHECK, CODEDENUM, GENERICBITSTRING, CONSTRUCTED, ENTRYTIME, PHYCOMADDR, CURRENCY, OPTFLDS, TRGOPS</div></div></td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">ld\_instance</td><td style="width: 71.9602px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Instance of a logical device</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.963px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">ln\_class</td><td style="width: 71.9602px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Logical node class type</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.963px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">ln\_instance</td><td style="width: 71.9602px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Instance of a logical node </td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.963px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">ln\_prefix</td><td style="width: 71.9602px; height: 29px;">string, integer</td><td style="width: 271.989px; height: 29px;">Prefix of logical node string</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.963px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 10px;">cdc</td><td style="width: 71.9602px; height: 10px;">string</td><td style="width: 271.989px; height: 10px;">Common Data Class (CDC) name</td><td style="width: 78.9915px; height: 10px;">Yes</td><td style="width: 108.963px; height: 10px;">  
</td><td colspan="2" style="width: 137.983px; height: 10px;">SPS, DPS, INS, ENS, ACT, ACD, SEC, BCR, HST, VSS, MV, CMV, SAV, WYE, DEL, SEQ, HMV, HWYE, HDEL, SPC, DPC, INC, ENC, BSC, ISC, APC, BAC, SPG, ING, ENG, ORG, TSG, CUG, VSG, ASG, CURVE, CSG, DPL, LPL, CSD, UNDEF</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">data\_object</td><td style="width: 71.9602px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Name of data object in dataset</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.963px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">da\_value</td><td style="width: 71.9602px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Name of a data attribute value node</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.963px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">da\_fc</td><td style="width: 71.9602px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Functional constrain for data object</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.963px; height: 29px;">  
</td><td colspan="2" style="width: 137.983px; height: 29px;">ST,MX, CO, SP, SE</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 10px;">control\_model</td><td style="width: 71.9602px; height: 10px;">string

</td><td style="width: 271.989px; height: 10px;">Model of output control

</td><td style="width: 78.9915px; height: 10px;">No

</td><td style="width: 108.963px; height: 10px;">read-only</td><td colspan="2" style="width: 137.983px; height: 10px;">read-only,

direct-with-normal-security,

sbo-with-normal-security,

direct-with-enhanced-security, sbo-with-enhanced-security

</td></tr><tr style="height: 57px;"><td style="width: 130px; height: 57px;">dataset

</td><td style="width: 71.9602px; height: 57px;">string

</td><td style="width: 271.989px; height: 57px;">Full object reference of a dataset

</td><td style="width: 78.9915px; height: 57px;">Yes

</td><td style="width: 108.963px; height: 57px;">  
</td><td style="height: 57px; width: 68.9915px;">  
</td><td style="width: 68.9915px; height: 57px;">  
</td></tr><tr style="height: 124px;"><td style="width: 130px; height: 10px;">report\_control\_block

</td><td style="width: 71.9602px; height: 10px;">string

</td><td style="width: 271.989px; height: 10px;">Full object reference of a report control block

</td><td style="width: 78.9915px; height: 10px;">Yes

</td><td style="width: 108.963px; height: 10px;">  
</td><td colspan="2" style="width: 137.983px; height: 10px;">  
</td></tr><tr style="height: 57px;"><td style="width: 130px; height: 10px;">intgPd

</td><td style="width: 71.9602px; height: 10px;">integer

</td><td style="width: 271.989px; height: 10px;">Integrity period in milliseconds

</td><td style="width: 78.9915px; height: 10px;">No

</td><td style="width: 108.963px; height: 10px;">0</td><td style="width: 68.9915px; height: 10px;">  
</td><td style="width: 68.9915px; height: 10px;">  
</td></tr></tbody></table>

<p class="callout info">It should be noted that ACT and ACD messages can only be parsed from report if either only ‘general’ attribute or all attributes attached to all three phases and neutral can be found in report</p>

##### Device status signals

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk--8" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>IEC 61850 has an additional signal which can be configured to show communication status. It is used to indicate if the server device has disconnected from client (WCC Lite). To configure such signal for IEC 61850 protocol, job\_todo and tag\_job\_todo fields with string values are required. For IEC 61850 client required parameters for status signal will be: **signal\_name,** **device\_alias, signal\_alias, number\_type, job\_todo** and **tag\_job\_todo**. Job\_todo value must be *device\_status* and for tag\_job\_todo there are 4 variations: communication\_status, device\_running, device\_error, uknown\_error. Each signal has 4 possible values and are based on the same logic. If signal returns value of 0, it means unknown error has appeared, 1 – device or protocol connection is on and working properly, 2 – device is off or protocol is disconnected, 3 – error or service is down.

#### Configuration

Configuration of IEC61850 Client for WCCLite is done via WCC Utility. Elseta WCC Utility has two IEC 61850 selections - IEC 61850 Config and IEC 61850 Excel:

- **IEC 61850 Config** is used to create a configuration model file, which IEC 61850 Client service will use to parse reports from the server.
- **IEC 61850 Excel** is used to generate excel configuration file which in turn will be used to generated configuration .json via excel-utility.

[![image-1670584678497.png](https://wiki.elseta.com/uploads/images/gallery/2022-12/scaled-1680-/image-1670584678497.png)](https://wiki.elseta.com/uploads/images/gallery/2022-12/image-1670584678497.png)

WCC Utility with IEC61850 selections

##### Generate model file<button aria-label="Copy link to heading" class="css-779anb"><svg height="24" role="presentation" viewbox="0 0 24 24" width="24"></svg></button>

To generate IEC 61850 Client model file select “Client” in drop down selection tab. Then select where to output the generated model and upload file with extensions .icd, .scd or .cid.

[![image-1670585363191.png](https://wiki.elseta.com/uploads/images/gallery/2022-12/scaled-1680-/image-1670585363191.png)](https://wiki.elseta.com/uploads/images/gallery/2022-12/image-1670585363191.png)

Generate IEC 61850 Client model file

##### Generate excel file

To generate IEC 61850 Client excel file select “Client” in drop down selection tab. Then select where to output the generated model upload file with extensions .icd, .scd or .cid.

[![image-1670585447382.png](https://wiki.elseta.com/uploads/images/gallery/2022-12/scaled-1680-/image-1670585447382.png)](https://wiki.elseta.com/uploads/images/gallery/2022-12/image-1670585447382.png)

Generate IEC 61850 Client excel file

After generating excel file additional configuration information must be written in the devices sheet:

- A valid host ip address must be provided.
- An authorization method must be provided (if it is a complex authorization method, additional parameters might be required).
- Model filename must be provided. The model filename must be exactly the same as that was generated one step earlier (Model filename can include extension, but it is not mandatory).

[![image-1676877418592.png](https://wiki.elseta.com/uploads/images/gallery/2023-02/scaled-1680-/image-1676877418592.png)](https://wiki.elseta.com/uploads/images/gallery/2023-02/image-1676877418592.png)

Excel configuration (Devices sheet)

In the signals sheet, signals which are not used or needed can be removed. Their information might be modified as well.

[![image-1670586268060.png](https://wiki.elseta.com/uploads/images/gallery/2022-12/scaled-1680-/image-1670586268060.png)](https://wiki.elseta.com/uploads/images/gallery/2022-12/image-1670586268060.png)Signals sheet

**Important!** Information such as ld\_instance and other data taken directly from SCD configuration files should not be modified, otherwise access to info of these reports can be broken.

##### Uploading configuration<button aria-label="Copy link to heading" class="css-779anb"><svg height="24" role="presentation" viewbox="0 0 24 24" width="24"></svg></button>

First upload the model configuration file.

[![image-1689317512196.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689317512196.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689317512196.png)

Uploading model configuration file

After uploading the model configuration file it should appear under *the DOWNLOAD CONFIGURATION* tab.

[![image-1689317540477.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689317540477.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689317540477.png)

Uploaded IEC 6180 Client configuration file

Then upload the excel configuration (same as with every other protocol).

[![image-1670586406773.png](https://wiki.elseta.com/uploads/images/gallery/2022-12/scaled-1680-/image-1670586406773.png)](https://wiki.elseta.com/uploads/images/gallery/2022-12/image-1670586406773.png)

Uploading excel configuration

After successful configuration upload, both configurations should appear under *DOWNLOAD CONFIGURATION* tab. If any errors occur during excel upload, fix them along excel utility guidelines.

[![image-1670586443301.png](https://wiki.elseta.com/uploads/images/gallery/2022-12/scaled-1680-/image-1670586443301.png)](https://wiki.elseta.com/uploads/images/gallery/2022-12/image-1670586443301.png)

Uploaded configurations

#### IEC 61850 Client command line debugging options

`iec61850-client`

```
-h [ –help ] Show help message
-c [–config] arg Configuration file location 
-V [–version] Show version
-d [–debug] arg Set debugging level
-r [–redis] Show Redis messages 
-C [–commands] Show command messages 
-D [–datasets] Show dataset messages 
–report Show report messages 
-R [–readyfile] arg Ready notification file
```

<p class="callout warning">If IEC 61850 Client does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from command line interface and find out why link is not functioning properly.</p>

<p class="callout info">To launch a debugging session, a user should stop `iec61850-client` process by running `/etc/init.d/iec61850-client stop` and run `iec61850-client` command with respective flags as was shown above.</p>

# 16 Specific protocols

– Aurora (ABB PV inverters protocol)
– PowerOne (ABB PV inverters protocol)
– SMA Net (SMA PV inverters protocol)
– Kaco (Kaco PV inverters protocol)
– Ginlong (Ginlong PV inverters protocol)
– Solplus (Solutronic AG PV inverters protocol)
– ComLynx (Danfoss PV inverters protocol)
– Delta (Delta PV inverters protocol)
– Windlog (Wind sensors from RainWise Inc.)
– Vestas ( Wind turbines protocol)
– VBus.

# 16.1 At command

### Overview

At command protocol is used for communications with AT Commands.

### Configuration

##### At command parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 48px;"><td style="height: 48px; width: 130px;">name</td><td style="height: 48px; width: 72px;">string </td><td style="height: 48px; width: 272px;">User-friendly device name</td><td style="height: 48px; width: 79px;">Yes</td><td style="height: 48px; width: 109px;"></td><td style="height: 48px; width: 69px;">  
</td><td style="height: 48px; width: 69px;"></td></tr><tr style="height: 35px;"><td style="height: 35px; width: 130px;">description</td><td style="height: 35px; width: 72px;">string</td><td style="height: 35px; width: 272px;">Description of a device</td><td style="height: 35px; width: 79px;">No</td><td style="height: 35px; width: 109px;"></td><td style="height: 35px; width: 69px;">  
</td><td style="height: 35px; width: 69px;"></td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">device\_alias</td><td style="height: 46px; width: 72px;">string</td><td style="height: 46px; width: 272px;">Alphanumeric string to identify a device</td><td style="height: 46px; width: 79px;">Yes</td><td style="height: 46px; width: 109px;">  
</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">enable</td><td style="height: 46px; width: 72px;">boolean</td><td style="height: 46px; width: 272px;">Enabling/disabling of a device</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">1</td><td style="height: 46px; width: 69px;">0</td><td style="height: 46px; width: 69px;">1</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 130px;">protocol</td><td style="height: 35px; width: 72px;">string</td><td style="height: 35px; width: 272px;">Protocol to be used.</td><td style="height: 35px; width: 79px;">Yes</td><td style="height: 35px; width: 109px;">  
</td><td colspan="2" style="height: 35px; width: 138px;">at command

</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 130px;">device</td><td style="height: 29px; width: 72px;">string</td><td style="height: 29px; width: 272px;">Communication port</td><td style="height: 29px; width: 79px;">Yes</td><td style="height: 29px; width: 109px;">  
</td><td style="height: 29px; width: 69px;">PORT1</td><td style="height: 29px; width: 69px;">PORT2</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">baudrate</td><td style="height: 46px; width: 72px;">integer</td><td style="height: 46px; width: 272px;">Communication speed (bauds/s)</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">9600</td><td colspan="2" style="height: 46px; width: 138px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">databits</td><td style="height: 46px; width: 72px;">integer</td><td style="height: 46px; width: 272px;">Data bit count for communication</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">8</td><td style="height: 46px; width: 69px;">6</td><td style="height: 46px; width: 69px;">9</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">stopbits</td><td style="height: 46px; width: 72px;">integer</td><td style="height: 46px; width: 272px;">Stop bit count for communication</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">1</td><td style="height: 46px; width: 69px;">1</td><td style="height: 46px; width: 69px;">2</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 130px;">parity</td><td style="height: 29px; width: 72px;">string</td><td style="height: 29px; width: 272px;">Communication parity option</td><td style="height: 29px; width: 79px;">No</td><td style="height: 29px; width: 109px;">none</td><td colspan="2" style="height: 29px; width: 69px;">none, even, odd</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">flowcontrol</td><td style="height: 46px; width: 72px;">string</td><td style="height: 46px; width: 272px;">Communication device flow control option.</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">none</td><td colspan="2" style="height: 46px; width: 69px;">none</td></tr><tr style="height: 63px;"><td style="height: 63px; width: 130px;">timeout\_ms</td><td style="height: 63px; width: 72px;">integer</td><td style="height: 63px; width: 272px;">Timeout of waiting for incoming request in  
milliseconds</td><td style="height: 63px; width: 79px;">Yes</td><td style="height: 63px; width: 109px;">  
</td><td style="height: 63px; width: 69px;">0</td><td style="height: 63px; width: 69px;">60000</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">serial\_close\_delay</td><td style="height: 46px; width: 72px;">integer</td><td style="height: 46px; width: 272px;">Delay before closing serial port</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">400</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr></tbody></table>

##### At command parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 130.156px;">signal\_name</td><td style="width: 71.0781px;">string

</td><td style="width: 277.344px;">User-­friendly signal name

</td><td style="width: 77.0938px;">Yes</td><td style="width: 107.125px;">  
</td><td style="width: 68.0781px;"></td><td style="width: 68.125px;"></td></tr><tr><td style="width: 130.156px;">device\_alias</td><td style="width: 71.0781px;">string

</td><td style="width: 277.344px;">Device alias from a Devices tab

</td><td style="width: 77.0938px;">Yes</td><td style="width: 107.125px;">  
</td><td style="width: 68.0781px;"></td><td style="width: 68.125px;"></td></tr><tr><td style="width: 130.156px;">signal\_alias</td><td style="width: 71.0781px;">string

</td><td style="width: 277.344px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 77.0938px;">Yes</td><td style="width: 107.125px;">  
</td><td style="width: 68.0781px;"></td><td style="width: 68.125px;"></td></tr><tr><td style="width: 130.156px;">enable</td><td style="width: 71.0781px;">boolean

</td><td style="width: 277.344px;">Enabling/disabling of an individual signal

</td><td style="width: 77.0938px;">No</td><td style="width: 107.125px;">1</td><td style="width: 68.0781px;">0

</td><td style="width: 68.125px;">1

</td></tr><tr><td style="width: 130.156px;">log</td><td style="width: 71.0781px;">integer

</td><td style="width: 277.344px;">Enable logging in event log

</td><td style="width: 77.0938px;">No</td><td style="width: 107.125px;">0</td><td style="width: 68.0781px;"></td><td style="width: 68.125px;"></td></tr><tr><td style="width: 130.156px;">number\_type</td><td style="width: 71.0781px;">string</td><td style="width: 277.344px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 77.0938px;">Yes</td><td style="width: 107.125px;">  
</td><td style="width: 68.0781px;">  
</td><td style="width: 68.125px;">  
</td></tr><tr><td style="width: 130.156px;">job\_todo</td><td style="width: 71.0781px;">string

</td><td style="width: 277.344px;">Tag job as single or multiple comma separated OBIS codes

</td><td style="width: 77.0938px;">Yes</td><td style="width: 107.125px;">  
</td><td style="width: 68.0781px;"></td><td style="width: 68.125px;"></td></tr><tr><td style="width: 130.156px;">tag\_job\_todo</td><td style="width: 71.0781px;">string</td><td style="width: 277.344px;">Tag sub job</td><td style="width: 77.0938px;">Yes</td><td style="width: 107.125px;">  
</td><td style="width: 68.0781px;">  
</td><td style="width: 68.125px;">  
</td></tr></tbody></table>

# 16.2 Aurora

### Overview

  
The Aurora Protocol is a link layer communications protocol for use on point­-to-­point serial links. It  
is intended for use in high­speed (gigabits/second and more) connections internally in a computer  
or in an embedded system. It uses either 8b/10b encoding or 64b/66b encoding

#### Aurora parameters for Device tab:

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 71.9886px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 271.989px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 78.9915px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 108.991px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.997px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9915px;">Min

</td><td class="align-center" style="height: 51px; width: 69.0057px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">name</td><td style="width: 71.9886px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">User-friendly device name</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.991px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">description</td><td style="width: 71.9886px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Description of the device</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">device\_alias</td><td style="width: 71.9886px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Device alias to be used in configuration</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.991px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">enable</td><td style="width: 71.9886px; height: 29px;">boolean</td><td style="width: 271.989px; height: 29px;">Enabling/disabling of a device</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">1</td><td style="width: 68.9915px; height: 29px;">0</td><td style="width: 69.0057px; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">protocol</td><td style="width: 71.9886px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Selection of protocol</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.991px; height: 29px;">  
</td><td colspan="2" style="width: 137.997px; height: 29px;">Aurora</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">baudrate</td><td style="width: 71.9886px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Communication speed, bauds/s (See values 33.1.2)</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">9600</td><td colspan="2" style="width: 137.997px; height: 29px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">databits</td><td style="width: 71.9886px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Data bit count for communication</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">8</td><td style="width: 68.9915px; height: 29px;">6</td><td style="width: 69.0057px; height: 29px;">9</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">stopbits</td><td style="width: 71.9886px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Stop bit count for communication</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">1</td><td style="width: 68.9915px; height: 29px;">1</td><td style="width: 69.0057px; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">parity</td><td style="width: 71.9886px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Communication parity option  
(”none”/”even”/”odd”)</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">none</td><td colspan="2" style="height: 29px; width: 137.997px;">None, Even, Odd</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">flowcontrol</td><td style="width: 71.9886px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Communication device flow control option.</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">none</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">scan\_rate\_ms</td><td style="width: 71.9886px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">If provided and positive ­ all reads and writes will be executed within the timeframe in milliseconds.</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">10000</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">poll\_delay\_ms</td><td style="width: 71.9886px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">200</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">timeout\_ms</td><td style="width: 71.9886px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Timeout in milliseconds</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">2500</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">id</td><td style="width: 71.9886px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Inverter ID</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.991px; height: 29px;">0</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">device</td><td style="width: 71.9886px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Communication port</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.991px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">PORT1</td><td style="width: 69.0057px; height: 29px;">PORT2</td></tr></tbody></table>

#### Aurora parameters for Signals tab:

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 149px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 253px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">signal\_name</td><td style="width: 72px; height: 29px;">string</td><td style="width: 253px; height: 29px;">User-friendly device name</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">device\_alias</td><td style="width: 72px; height: 29px;">string</td><td style="width: 253px; height: 29px;">Device alias from a Devices tab</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">enable</td><td style="width: 72px; height: 29px;">boolean </td><td style="width: 253px; height: 29px;">Enabling/disabling of an individual signal </td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">1</td><td style="width: 69px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1</td></tr><tr><td style="width: 149px;">log </td><td style="width: 72px;">integer</td><td style="width: 253px;">Enable logging in event log (Default: 0)</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">0</td><td style="width: 69px;">  
</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">signal\_alias</td><td style="width: 72px; height: 29px;">string</td><td style="width: 253px; height: 29px;">Unique alphanumeric name of the signal to be used</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">job\_todo</td><td style="width: 72px; height: 29px;">boolean</td><td style="width: 253px; height: 29px;">Define tag­-function</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">tag\_job\_todo</td><td style="width: 72px; height: 29px;">string</td><td style="width: 253px; height: 29px;">Define tag action that depends on tag function</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">number\_type</td><td style="width: 72px; height: 29px;"><div><div>string</div></div></td><td style="width: 253px; height: 29px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">pulse\_short\_time\_ms</td><td style="width: 72px; height: 29px;">integer</td><td style="width: 253px; height: 29px;">Time interval for short output pulse to stay active</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">0</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 149px; height: 29px;">pulse\_long\_time\_ms</td><td style="width: 72px; height: 29px;">integer</td><td style="width: 253px; height: 29px;">Time interval for long output pulse to stay active</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">0</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr></tbody></table>

# 16.3 COMLYNX

### Overview

Comlynx protocol is used to communicate with Comlynx inverters over serial communication.

##### Comlynx parameters for *Device* tab:

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">name</td><td style="width: 81.6935px; height: 29px;">string</td><td style="width: 270.704px; height: 29px;">User-friendly device name</td><td style="width: 78.7074px; height: 29px;">Yes</td><td style="width: 104.714px; height: 29px;">  
</td><td style="width: 76.6935px; height: 29px;">  
</td><td style="width: 76.7108px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">description</td><td style="width: 81.6935px; height: 29px;">string</td><td style="width: 270.704px; height: 29px;">Description of the device</td><td style="width: 78.7074px; height: 29px;">No</td><td style="width: 104.714px; height: 29px;">  
</td><td style="width: 76.6935px; height: 29px;">  
</td><td style="width: 76.7108px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">device\_alias</td><td style="width: 81.6935px; height: 29px;">string</td><td style="width: 270.704px; height: 29px;">Device alias to be used in configuration</td><td style="width: 78.7074px; height: 29px;">Yes</td><td style="width: 104.714px; height: 29px;">  
</td><td style="width: 76.6935px; height: 29px;">  
</td><td style="width: 76.7108px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">enable</td><td style="width: 81.6935px; height: 29px;">boolean</td><td style="width: 270.704px; height: 29px;">Enabling/disabling of a device</td><td style="width: 78.7074px; height: 29px;">No</td><td style="width: 104.714px; height: 29px;">1</td><td style="width: 76.6935px; height: 29px;">0</td><td style="width: 76.7108px; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">protocol</td><td style="width: 81.6935px; height: 29px;">string</td><td style="width: 270.704px; height: 29px;">Selection of protocol</td><td style="width: 78.7074px; height: 29px;">Yes</td><td style="width: 104.714px; height: 29px;">  
</td><td colspan="2" style="height: 29px; width: 153.404px;">Comlynx</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">address</td><td style="width: 81.6935px; height: 29px;">integer</td><td style="width: 270.704px; height: 29px;">Device address</td><td style="width: 78.7074px; height: 29px;">No</td><td style="width: 104.714px; height: 29px;">1</td><td colspan="2" style="width: 153.404px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">subnet</td><td style="width: 81.6935px; height: 29px;">integer</td><td style="width: 270.704px; height: 29px;">Subnet address</td><td style="width: 78.7074px; height: 29px;">No</td><td style="width: 104.714px; height: 29px;">0</td><td colspan="2" style="width: 153.404px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">network</td><td style="width: 81.6935px; height: 29px;">integer</td><td style="width: 270.704px; height: 29px;">Network address</td><td style="width: 78.7074px; height: 29px;">No</td><td style="width: 104.714px; height: 29px;">0</td><td colspan="2" style="width: 153.404px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">device</td><td style="width: 81.6935px; height: 29px;">string</td><td style="width: 270.704px; height: 29px;">Communication port</td><td style="width: 78.7074px; height: 29px;">Yes</td><td style="width: 104.714px; height: 29px;">  
</td><td style="width: 76.6935px; height: 29px;">PORT1</td><td style="width: 76.7108px; height: 29px;">PORT2</td></tr><tr style="height: 46px;"><td style="width: 133.69px; height: 46px;">baudrate</td><td style="width: 81.6935px; height: 46px;">integer</td><td style="width: 270.704px; height: 46px;">Communication speed (bauds/s)</td><td style="width: 78.7074px; height: 46px;">No</td><td style="width: 104.714px; height: 46px;">19200</td><td colspan="2" style="width: 153.404px; height: 46px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">databits</td><td style="width: 81.6935px; height: 29px;">integer</td><td style="width: 270.704px; height: 29px;">Data bit count for communication</td><td style="width: 78.7074px; height: 29px;">No</td><td style="width: 104.714px; height: 29px;">8</td><td style="width: 76.6935px; height: 29px;">6</td><td style="width: 76.7108px; height: 29px;">9</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">stopbits</td><td style="width: 81.6935px; height: 29px;">integer</td><td style="width: 270.704px; height: 29px;">Stop bit count for communication</td><td style="width: 78.7074px; height: 29px;">No</td><td style="width: 104.714px; height: 29px;">1</td><td style="width: 76.6935px; height: 29px;">1</td><td style="width: 76.7108px; height: 29px;">2</td></tr><tr style="height: 46px;"><td style="width: 133.69px; height: 46px;">parity</td><td style="width: 81.6935px; height: 46px;">string</td><td style="width: 270.704px; height: 46px;">Communication parity option  
(”none”/”even”/”odd”)</td><td style="width: 78.7074px; height: 46px;">No</td><td style="width: 104.714px; height: 46px;">none</td><td style="width: 76.6935px; height: 46px;">  
</td><td style="width: 76.7108px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 133.69px; height: 46px;">flowcontrol</td><td style="width: 81.6935px; height: 46px;">string</td><td style="width: 270.704px; height: 46px;">Communication device flow control option. (Default: (case-sensitive): ”none”)</td><td style="width: 78.7074px; height: 46px;">No</td><td style="width: 104.714px; height: 46px;">none</td><td style="width: 76.6935px; height: 46px;">  
</td><td style="width: 76.7108px; height: 46px;">  
</td></tr><tr style="height: 63px;"><td style="width: 133.69px; height: 63px;">scan\_rate\_ms</td><td style="width: 81.6935px; height: 63px;">integer</td><td style="width: 270.704px; height: 63px;">If provided and positive ­ all reads and writes will be executed within the timeframe in milliseconds.</td><td style="width: 78.7074px; height: 63px;">No</td><td style="width: 104.714px; height: 63px;">10000</td><td style="width: 76.6935px; height: 63px;">  
</td><td style="width: 76.7108px; height: 63px;">  
</td></tr><tr style="height: 46px;"><td style="width: 133.69px; height: 46px;">poll\_delay\_ms</td><td style="width: 81.6935px; height: 46px;">integer</td><td style="width: 270.704px; height: 46px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 78.7074px; height: 46px;">No</td><td style="width: 104.714px; height: 46px;">200</td><td style="width: 76.6935px; height: 46px;">  
</td><td style="width: 76.7108px; height: 46px;">  
</td></tr><tr style="height: 29px;"><td style="width: 133.69px; height: 29px;">timeout\_ms</td><td style="width: 81.6935px; height: 29px;">integer</td><td style="width: 270.704px; height: 29px;">Timeout in milliseconds</td><td style="width: 78.7074px; height: 29px;">Yes</td><td style="width: 104.714px; height: 29px;">  
</td><td style="width: 76.6935px; height: 29px;">0</td><td style="width: 76.7108px; height: 29px;">60000</td></tr></tbody></table>

##### Comlynx parameters for *Signals* tab:

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 147px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 69px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 258px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 147px;">signal\_name</td><td style="width: 69px;">string</td><td style="width: 258px;">User-friendly device name</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 147px;">device\_alias</td><td style="width: 69px;">string</td><td style="width: 258px;">Device alias from a Devices tab</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 147px;">signal\_alias</td><td style="width: 69px;">string</td><td style="width: 258px;">Unique alphanumeric name of the signal to be used</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 147px;">enable</td><td style="width: 69px;">boolean</td><td style="width: 258px;">Enabling/disabling of an individual signal</td><td style="width: 79px;">No</td><td style="width: 109px;">1</td><td style="width: 69px;">0</td><td style="width: 69px;">1</td></tr><tr><td style="width: 147px;">log</td><td style="width: 69px;">integer</td><td style="width: 258px;">Allow signal to be logged.</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 147px;">job\_todo</td><td style="width: 69px;">boolean</td><td style="width: 258px;">Define tag­-function</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 147px;">tag\_job\_todo</td><td style="width: 69px;">string</td><td style="width: 258px;">Define tag action that depends on tag function</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 147px;">number\_type</td><td style="width: 69px;"><div><div>string</div></div></td><td style="width: 258px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 147px;">pulse\_short\_time\_ms</td><td style="width: 69px;">integer</td><td style="width: 258px;">Time interval for short output pulse to stay active</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 147px;">pulse\_long\_time\_ms</td><td style="width: 69px;">integer</td><td style="width: 258px;">Time interval for long output pulse to stay active</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr></tbody></table>

# 16.4 Delta

### Overview

Delta protocol is used to communicate with Delta inverters over serial communication.

### Configuration

##### Delta parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 71.9744px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 271.989px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 78.9915px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 108.977px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.997px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9915px;">Min

</td><td class="align-center" style="height: 51px; width: 69.0057px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">name</td><td style="width: 71.9744px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">User-friendly device name</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.977px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">description</td><td style="width: 71.9744px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Description of the device</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.977px; height: 29px;">  
</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">device\_alias</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Device alias to be used in configuration</td><td style="width: 78.9915px; height: 46px;">Yes</td><td style="width: 108.977px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 69.0057px; height: 46px;">  
</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">enable</td><td style="width: 71.9744px; height: 29px;">boolean</td><td style="width: 271.989px; height: 29px;">Enabling/disabling of a device</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.977px; height: 29px;">1</td><td style="width: 68.9915px; height: 29px;">0</td><td style="width: 69.0057px; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">protocol</td><td style="width: 71.9744px; height: 29px;">string</td><td style="width: 271.989px; height: 29px;">Selection of protocol</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.977px; height: 29px;">  
</td><td colspan="2" style="width: 137.997px; height: 29px;">Delta</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">baudrate</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Communication speed (bauds/s)</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">9600</td><td colspan="2" style="width: 137.997px; height: 46px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">databits</td><td style="width: 71.9744px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Data bit count for communication</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.977px; height: 29px;">8</td><td style="width: 68.9915px; height: 29px;">6</td><td style="width: 69.0057px; height: 29px;">9</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">stopbits</td><td style="width: 71.9744px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Stop bit count for communication</td><td style="width: 78.9915px; height: 29px;">No</td><td style="width: 108.977px; height: 29px;">1</td><td style="width: 68.9915px; height: 29px;">1</td><td style="width: 69.0057px; height: 29px;">2</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">parity</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Communication parity option  
(”none”/”even”/”odd”)</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">none</td><td colspan="2" style="height: 46px; width: 137.997px;">None, Even, Odd</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">flowcontrol</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Communication device flow control option. (Default: (case-sensitive): ”none”)</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">none</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 69.0057px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">scan\_rate\_ms</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">If provided and positive ­ all reads and writes will be executed within the timeframe in milliseconds.</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">10000</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 69.0057px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">poll\_delay\_ms</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">200</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 69.0057px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">timeout\_ms</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Timeout in milliseconds</td><td style="width: 78.9915px; height: 46px;">Yes</td><td style="width: 108.977px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">0</td><td style="width: 69.0057px; height: 46px;">60000</td></tr><tr style="height: 29px;"><td style="width: 130px; height: 29px;">id</td><td style="width: 71.9744px; height: 29px;">integer</td><td style="width: 271.989px; height: 29px;">Inverter ID</td><td style="width: 78.9915px; height: 29px;">Yes</td><td style="width: 108.977px; height: 29px;">0</td><td style="width: 68.9915px; height: 29px;">  
</td><td style="width: 69.0057px; height: 29px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">device</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Communication port</td><td style="width: 78.9915px; height: 46px;">Yes</td><td style="width: 108.977px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">PORT1</td><td style="width: 69.0057px; height: 46px;">PORT2</td></tr></tbody></table>

##### Delta parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 147px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 73px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 254px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 147px;">signal\_name</td><td style="height: 35px; width: 73px;">string

</td><td style="height: 35px; width: 254px;">User-­friendly signal name

</td><td style="height: 35px; width: 79px;">Yes</td><td style="height: 35px; width: 109px;">  
</td><td style="height: 35px; width: 69px;"></td><td style="height: 35px; width: 69px;"></td></tr><tr style="height: 35px;"><td style="height: 35px; width: 147px;">device\_alias</td><td style="height: 35px; width: 73px;">string

</td><td style="height: 35px; width: 254px;">Device alias from a Devices tab

</td><td style="height: 35px; width: 79px;">Yes</td><td style="height: 35px; width: 109px;">  
</td><td style="height: 35px; width: 69px;"></td><td style="height: 35px; width: 69px;"></td></tr><tr style="height: 35px;"><td style="height: 35px; width: 147px;">signal\_alias</td><td style="height: 35px; width: 73px;">string

</td><td style="height: 35px; width: 254px;">Unique alphanumeric name of the signal to be used

</td><td style="height: 35px; width: 79px;">Yes</td><td style="height: 35px; width: 109px;">  
</td><td style="height: 35px; width: 69px;"></td><td style="height: 35px; width: 69px;"></td></tr><tr style="height: 57px;"><td style="height: 57px; width: 147px;">enable</td><td style="height: 57px; width: 73px;">boolean

</td><td style="height: 57px; width: 254px;">Enabling/disabling of an individual signal

</td><td style="height: 57px; width: 79px;">No</td><td style="height: 57px; width: 109px;">1</td><td style="height: 57px; width: 69px;">0

</td><td style="height: 57px; width: 69px;">1

</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 147px;">log</td><td style="height: 35px; width: 73px;">integer

</td><td style="height: 35px; width: 254px;">Enable logging in event log

</td><td style="height: 35px; width: 79px;">No</td><td style="height: 35px; width: 109px;">0</td><td style="height: 35px; width: 69px;"></td><td style="height: 35px; width: 69px;"></td></tr><tr style="height: 29px;"><td style="height: 29px; width: 147px;">number\_type</td><td style="height: 29px; width: 73px;">string</td><td style="height: 29px; width: 254px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="height: 29px; width: 79px;">Yes</td><td style="height: 29px; width: 109px;">  
</td><td style="height: 29px; width: 69px;">  
</td><td style="height: 29px; width: 69px;">  
</td></tr><tr style="height: 57px;"><td style="height: 57px; width: 147px;">job\_todo</td><td style="height: 57px; width: 73px;">string

</td><td style="height: 57px; width: 254px;">Tag job as single or multiple comma separated OBIS codes

</td><td style="height: 57px; width: 79px;">Yes</td><td style="height: 57px; width: 109px;">  
</td><td style="height: 57px; width: 69px;"></td><td style="height: 57px; width: 69px;"></td></tr><tr style="height: 29px;"><td style="height: 29px; width: 147px;">tag\_job\_todo</td><td style="height: 29px; width: 73px;">string</td><td style="height: 29px; width: 254px;">Tag sub job</td><td style="height: 29px; width: 79px;">Yes</td><td style="height: 29px; width: 109px;">  
</td><td style="height: 29px; width: 69px;">  
</td><td style="height: 29px; width: 69px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 147px;">pulse\_short\_time\_ms</td><td style="height: 46px; width: 73px;">integer</td><td style="height: 46px; width: 254px;">Time interval for short output pulse to stay  
active</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">0</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 147px;">pulse\_long\_time\_ms</td><td style="height: 46px; width: 73px;">integer</td><td style="height: 46px; width: 254px;">Time interval for long output pulse to stay active</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">0</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr></tbody></table>

# 16.5 GINLONG

### Overview

Ginlong protocol is used to communicate with Ginlong inverters over serial communication.

##### GINLONG parameters for *Device* tab:

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 71.9744px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 271.989px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 78.9915px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 108.977px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.983px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9915px;">Min

</td><td class="align-center" style="height: 51px; width: 68.9915px;">Max

</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">name</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">User-friendly device name</td><td style="width: 78.9915px; height: 46px;">Yes</td><td style="width: 108.977px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">description</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Description of the device</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">device\_alias</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Device alias to be used in configuration</td><td style="width: 78.9915px; height: 46px;">Yes</td><td style="width: 108.977px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">enable</td><td style="width: 71.9744px; height: 46px;">boolean</td><td style="width: 271.989px; height: 46px;">Enabling/disabling of a device</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">1</td><td style="width: 68.9915px; height: 46px;">0</td><td style="width: 68.9915px; height: 46px;">1</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">protocol</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Selection of protocol</td><td style="width: 78.9915px; height: 46px;">Yes</td><td style="width: 108.977px; height: 46px;">  
</td><td colspan="2" style="width: 137.983px; height: 46px;">Ginlong</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">baudrate</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Communication speed (bauds/s) (See values 33.1.2)</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">9600</td><td colspan="2" style="height: 46px; width: 137.983px;"><div><div>300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200</div></div></td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">databits</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Data bit count for communication</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">8</td><td style="width: 68.9915px; height: 46px;">6</td><td style="width: 68.9915px; height: 46px;">9</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">stopbits</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Stop bit count for communication</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">1</td><td style="width: 68.9915px; height: 46px;">1</td><td style="width: 68.9915px; height: 46px;">2</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">parity</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Communication parity option  
(”none”/”even”/”odd”)</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">none</td><td colspan="2" style="height: 46px; width: 137.983px;">None, Even, Odd</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">flowcontrol</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Communication device flow control option. (Default: (case-sensitive): ”none”)</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">none</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">scan\_rate\_ms</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">If provided and positive ­ all reads and writes will be executed within the timeframe in milliseconds.</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">10000</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">poll\_delay\_ms</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">200</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">timeout\_ms</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Timeout in milliseconds</td><td style="width: 78.9915px; height: 46px;">No</td><td style="width: 108.977px; height: 46px;">2500</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">id</td><td style="width: 71.9744px; height: 46px;">integer</td><td style="width: 271.989px; height: 46px;">Inverter ID</td><td style="width: 78.9915px; height: 46px;">Yes</td><td style="width: 108.977px; height: 46px;">0</td><td style="width: 68.9915px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 130px; height: 46px;">device</td><td style="width: 71.9744px; height: 46px;">string</td><td style="width: 271.989px; height: 46px;">Communication port</td><td style="width: 78.9915px; height: 46px;">Yes</td><td style="width: 108.977px; height: 46px;">  
</td><td style="width: 68.9915px; height: 46px;">PORT1</td><td style="width: 68.9915px; height: 46px;">PORT2</td></tr></tbody></table>

##### GINLONG parameters for Signals tab:

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 146px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 68px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 260px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 146px;">signal\_name</td><td style="height: 29px; width: 68px;">string</td><td style="height: 29px; width: 260px;">User-friendly device name</td><td style="height: 29px; width: 79px;">Yes</td><td style="height: 29px; width: 109px;">  
</td><td style="height: 29px; width: 69px;">  
</td><td style="height: 29px; width: 69px;">  
</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 146px;">device\_alias</td><td style="height: 29px; width: 68px;">string</td><td style="height: 29px; width: 260px;">Device alias from a Devices tab</td><td style="height: 29px; width: 79px;">Yes</td><td style="height: 29px; width: 109px;">  
</td><td style="height: 29px; width: 69px;">  
</td><td style="height: 29px; width: 69px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 146px;">signal\_alias</td><td style="height: 46px; width: 68px;">string</td><td style="height: 46px; width: 260px;">Unique alphanumeric name of the signal to be used</td><td style="height: 46px; width: 79px;">Yes</td><td style="height: 46px; width: 109px;">  
</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr><tr style="height: 40px;"><td style="width: 146px; height: 40px;">enable</td><td style="width: 68px; height: 40px;">boolean</td><td style="width: 260px; height: 40px;">Enabling/disabling of an individual signal</td><td style="width: 79px; height: 40px;">No</td><td style="width: 109px; height: 40px;">1</td><td style="width: 69px; height: 40px;">0</td><td style="width: 69px; height: 40px;">1</td></tr><tr style="height: 29px;"><td style="width: 146px; height: 29px;">log</td><td style="width: 68px; height: 29px;">integer</td><td style="width: 260px; height: 29px;">Allow signal to be logged.</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">0</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 146px;">job\_todo</td><td style="height: 46px; width: 68px;">string</td><td style="height: 46px; width: 260px;">Define tag­-function</td><td style="height: 46px; width: 79px;">Yes</td><td style="height: 46px; width: 109px;">  
</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 146px;">tag\_job\_todo</td><td style="height: 29px; width: 68px;">string</td><td style="height: 29px; width: 260px;">Define tag action that depends on tag function</td><td style="height: 29px; width: 79px;">Yes</td><td style="height: 29px; width: 109px;">  
</td><td style="height: 29px; width: 69px;">  
</td><td style="height: 29px; width: 69px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 146px;">number\_type</td><td style="height: 46px; width: 68px;">string</td><td style="height: 46px; width: 260px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="height: 46px; width: 79px;">Yes</td><td style="height: 46px; width: 109px;">  
</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 146px;">pulse\_short\_time\_ms</td><td style="height: 46px; width: 68px;">integer</td><td style="height: 46px; width: 260px;">Time interval for short output pulse to stay active</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">0</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 146px;">pulse\_long\_time\_ms</td><td style="height: 46px; width: 68px;">integer</td><td style="height: 46px; width: 260px;">Time interval for long output pulse to stay active</td><td style="height: 46px; width: 79px;">No</td><td style="height: 46px; width: 109px;">0</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr></tbody></table>

# 16.6 Kaco

### Overview

This protocol is meant to be used by inverters that convert the DC power generated by the photovoltaic (PV) modules into AC power and feed this into the power grid.

<p class="callout info">This protocol handles serial communication parameters (baudrate, databits, stopbits, etc.) automatically.</p>

### Configuration

##### Kaco parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35.4688px;"><td style="height: 35.4688px; width: 97.1007px;">name</td><td style="height: 35.4688px; width: 65.0521px;">string </td><td style="height: 35.4688px; width: 306.372px;">User-friendly device name</td><td style="height: 35.4688px; width: 105.035px;">Yes</td><td style="height: 35.4688px; width: 96.0764px;"></td><td style="height: 35.4688px; width: 69.6007px;">  
</td><td style="height: 35.4688px; width: 69.6528px;"></td></tr><tr style="height: 35.4688px;"><td style="height: 35.4688px; width: 97.1007px;">description</td><td style="height: 35.4688px; width: 65.0521px;">string</td><td style="height: 35.4688px; width: 306.372px;">Description of a device</td><td style="height: 35.4688px; width: 105.035px;">No</td><td style="height: 35.4688px; width: 96.0764px;"></td><td style="height: 35.4688px; width: 69.6007px;">  
</td><td style="height: 35.4688px; width: 69.6528px;"></td></tr><tr style="height: 29.8785px;"><td style="height: 29.8785px; width: 97.1007px;">device\_alias</td><td style="height: 29.8785px; width: 65.0521px;">string</td><td style="height: 29.8785px; width: 306.372px;">Alphanumeric string to identify a device</td><td style="height: 29.8785px; width: 105.035px;">Yes</td><td style="height: 29.8785px; width: 96.0764px;">  
</td><td style="height: 29.8785px; width: 69.6007px;">  
</td><td style="height: 29.8785px; width: 69.6528px;">  
</td></tr><tr style="height: 46.6667px;"><td style="height: 46.6667px; width: 97.1007px;">enable</td><td style="height: 46.6667px; width: 65.0521px;">boolean</td><td style="height: 46.6667px; width: 306.372px;">Enabling/disabling of a device</td><td style="height: 46.6667px; width: 105.035px;">No</td><td style="height: 46.6667px; width: 96.0764px;">1</td><td style="height: 46.6667px; width: 69.6007px;">0</td><td style="height: 46.6667px; width: 69.6528px;">1</td></tr><tr style="height: 35.4688px;"><td style="height: 35.4688px; width: 97.1007px;">protocol</td><td style="height: 35.4688px; width: 65.0521px;">string</td><td style="height: 35.4688px; width: 306.372px;">Protocol to be used.</td><td style="height: 35.4688px; width: 105.035px;">Yes</td><td style="height: 35.4688px; width: 96.0764px;">  
</td><td colspan="2" style="height: 35.4688px; width: 139.254px;">Kaco

</td></tr><tr style="height: 48.8889px;"><td style="height: 48.8889px; width: 97.1007px;">scan\_rate\_ms</td><td style="height: 48.8889px; width: 65.0521px;">integer</td><td style="height: 48.8889px; width: 306.372px;">All reads and writes will be executed within the  
timeframe in milliseconds.</td><td style="height: 48.8889px; width: 105.035px;">No</td><td style="height: 48.8889px; width: 96.0764px;">10000</td><td colspan="2" style="height: 48.8889px; width: 139.254px;"></td></tr><tr style="height: 48.8889px;"><td style="height: 48.8889px; width: 97.1007px;">poll\_delay\_ms</td><td style="height: 48.8889px; width: 65.0521px;">integer</td><td style="height: 48.8889px; width: 306.372px;">Minimum time delay in milliseconds to wait  
before sending any data on port.</td><td style="height: 48.8889px; width: 105.035px;">No</td><td style="height: 48.8889px; width: 96.0764px;">200</td><td colspan="2" style="height: 48.8889px; width: 139.254px;"></td></tr><tr style="height: 46.6667px;"><td style="height: 46.6667px; width: 97.1007px;">timeout\_ms</td><td style="height: 46.6667px; width: 65.0521px;">integer</td><td style="height: 46.6667px; width: 306.372px;">Timeout of waiting for incoming request in miliseconds</td><td style="height: 46.6667px; width: 105.035px;">Yes</td><td style="height: 46.6667px; width: 96.0764px;">2500</td><td style="height: 46.6667px; width: 69.6007px;">0</td><td style="height: 46.6667px; width: 69.6528px;">60000</td></tr><tr style="height: 29.8785px;"><td style="height: 29.8785px; width: 97.1007px;">subid</td><td style="height: 29.8785px; width: 65.0521px;">integer</td><td style="height: 29.8785px; width: 306.372px;">Inverter serial number display</td><td style="height: 29.8785px; width: 105.035px;">Yes</td><td style="height: 29.8785px; width: 96.0764px;">0</td><td style="height: 29.8785px; width: 69.6007px;">  
</td><td style="height: 29.8785px; width: 69.6528px;">  
</td></tr><tr style="height: 46.6667px;"><td style="height: 46.6667px; width: 97.1007px;">ext\_device</td><td style="height: 46.6667px; width: 65.0521px;">boolean</td><td style="height: 46.6667px; width: 306.372px;">0 ­- Inverter is connected directly  
1 -­ Inverter is connected via remote terminal</td><td style="height: 46.6667px; width: 105.035px;">Yes</td><td style="height: 46.6667px; width: 96.0764px;">0</td><td style="height: 46.6667px; width: 69.6007px;">0</td><td style="height: 46.6667px; width: 69.6528px;">1</td></tr><tr style="height: 29.8785px;"><td style="height: 29.8785px; width: 97.1007px;">id</td><td style="height: 29.8785px; width: 65.0521px;">integer</td><td style="height: 29.8785px; width: 306.372px;">Inverter serial number</td><td style="height: 29.8785px; width: 105.035px;">Yes</td><td style="height: 29.8785px; width: 96.0764px;">  
</td><td style="height: 29.8785px; width: 69.6007px;">  
</td><td style="height: 29.8785px; width: 69.6528px;">  
</td></tr><tr style="height: 29.8785px;"><td style="width: 97.1007px; height: 29.8785px;">device</td><td style="width: 65.0521px; height: 29.8785px;">string</td><td style="width: 306.372px; height: 29.8785px;">Communication port</td><td style="width: 105.035px; height: 29.8785px;">Yes</td><td style="width: 96.0764px; height: 29.8785px;">  
</td><td style="width: 69.6007px; height: 29.8785px;">PORT1</td><td style="width: 69.6528px; height: 29.8785px;">PORT2</td></tr></tbody></table>

##### Kaco parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 148px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 69px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 257px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 148px;">signal\_name</td><td style="width: 69px;">string

</td><td style="width: 257px;">User-­friendly signal name

</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;"></td><td style="width: 69px;"></td></tr><tr><td style="width: 148px;">device\_alias</td><td style="width: 69px;">string

</td><td style="width: 257px;">Device alias from a Devices tab

</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;"></td><td style="width: 69px;"></td></tr><tr><td style="width: 148px;">signal\_alias</td><td style="width: 69px;">string

</td><td style="width: 257px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;"></td><td style="width: 69px;"></td></tr><tr><td style="width: 148px;">enable</td><td style="width: 69px;">boolean

</td><td style="width: 257px;">Enabling/disabling of an individual signal

</td><td style="width: 79px;">No</td><td style="width: 109px;">1</td><td style="width: 69px;">0

</td><td style="width: 69px;">1

</td></tr><tr><td style="width: 148px;">log</td><td style="width: 69px;">integer

</td><td style="width: 257px;">Enable logging in event log

</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;"></td><td style="width: 69px;"></td></tr><tr><td style="width: 148px;">number\_type</td><td style="width: 69px;">string</td><td style="width: 257px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 148px;">job\_todo</td><td style="width: 69px;">string

</td><td style="width: 257px;">Tag job as single or multiple comma separated OBIS codes

</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;"></td><td style="width: 69px;"></td></tr><tr><td style="width: 148px;">tag\_job\_todo</td><td style="width: 69px;">string</td><td style="width: 257px;">Tag sub job</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 148px;">pulse\_short\_time\_ms</td><td style="width: 69px;">integer</td><td style="width: 257px;">Time interval for short output pulse to stay  
active</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 148px;">pulse\_long\_time\_ms</td><td style="width: 69px;">integer</td><td style="width: 257px;">Time interval for long output pulse to stay active</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr></tbody></table>

# 16.7 POWERONE

### Overview

PowerOne protocol is used to communicate with Aurora inverters over serial communication. Serial communication parameters (baudrate, parity, etc.) are handled automatically by the protocol.

### Configuration

##### PowerOne parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 71.9744px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 271.989px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 78.9915px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 108.977px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.997px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9915px;">Min

</td><td class="align-center" style="height: 51px; width: 69.0057px;">Max

</td></tr><tr style="height: 52px;"><td class="align-center" style="height: 52px; width: 130px;">Min

</td><td class="align-center" style="height: 52px; width: 71.9744px;">Max

</td><td style="width: 271.989px;">  
</td><td style="width: 78.9915px;">  
</td><td style="width: 108.977px;">  
</td><td style="width: 68.9915px;">  
</td><td style="width: 69.0057px;">  
</td></tr><tr style="height: 48px;"><td style="height: 48px; width: 130px;">name</td><td style="height: 48px; width: 71.9744px;">string </td><td style="height: 48px; width: 271.989px;">User-friendly device name</td><td style="height: 48px; width: 78.9915px;">Yes</td><td style="height: 48px; width: 108.977px;"></td><td style="height: 48px; width: 68.9915px;">  
</td><td style="height: 48px; width: 69.0057px;"></td></tr><tr style="height: 35px;"><td style="height: 35px; width: 130px;">description</td><td style="height: 35px; width: 71.9744px;">string</td><td style="height: 35px; width: 271.989px;">Description of a device</td><td style="height: 35px; width: 78.9915px;">No</td><td style="height: 35px; width: 108.977px;"></td><td style="height: 35px; width: 68.9915px;">  
</td><td style="height: 35px; width: 69.0057px;"></td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">device\_alias</td><td style="height: 46px; width: 71.9744px;">string</td><td style="height: 46px; width: 271.989px;">Alphanumeric string to identify a device</td><td style="height: 46px; width: 78.9915px;">Yes</td><td style="height: 46px; width: 108.977px;">  
</td><td style="height: 46px; width: 68.9915px;">  
</td><td style="height: 46px; width: 69.0057px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">enable</td><td style="height: 46px; width: 71.9744px;">boolean</td><td style="height: 46px; width: 271.989px;">Enabling/disabling of a device</td><td style="height: 46px; width: 78.9915px;">No</td><td style="height: 46px; width: 108.977px;">1</td><td style="height: 46px; width: 68.9915px;">0</td><td style="height: 46px; width: 69.0057px;">1</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 130px;">protocol</td><td style="height: 35px; width: 71.9744px;">string</td><td style="height: 35px; width: 271.989px;">Protocol to be used.</td><td style="height: 35px; width: 78.9915px;">Yes</td><td style="height: 35px; width: 108.977px;">  
</td><td colspan="2" style="height: 35px; width: 137.997px;">powerone

</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">serialnumber</td><td style="height: 46px; width: 71.9744px;">integer</td><td style="height: 46px; width: 271.989px;">Inverter serial number</td><td style="height: 46px; width: 78.9915px;">Yes</td><td style="height: 46px; width: 108.977px;">  
</td><td style="height: 46px; width: 68.9915px;">  
</td><td style="height: 46px; width: 69.0057px;">  
</td></tr><tr style="height: 126px;"><td style="width: 130px; height: 126px;">type</td><td style="width: 71.9744px; height: 126px;"><div><div>string</div></div></td><td style="width: 271.989px; height: 126px;">Inverter type :

- CU ­ Collecting unit
- CB ­ Normal CB
- HID ­ HID with integrated CB

</td><td style="width: 78.9915px; height: 126px;">No</td><td style="width: 108.977px; height: 126px;">CU</td><td colspan="2" style="height: 126px; width: 137.997px;">CU, CB, HID</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 130px;">device</td><td style="height: 29px; width: 71.9744px;">  
</td><td style="height: 29px; width: 271.989px;">Communication port</td><td style="height: 29px; width: 78.9915px;">Yes</td><td style="height: 29px; width: 108.977px;">  
</td><td style="height: 29px; width: 68.9915px;">PORT1</td><td style="height: 29px; width: 69.0057px;">PORT2</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">baudrate</td><td style="height: 46px; width: 71.9744px;">integer</td><td style="height: 46px; width: 271.989px;">Communication speed (bauds/s)</td><td style="height: 46px; width: 78.9915px;">No</td><td style="height: 46px; width: 108.977px;">9600</td><td colspan="2" style="height: 46px; width: 137.997px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">scan\_rate\_ms</td><td style="height: 46px; width: 71.9744px;">integer</td><td style="height: 46px; width: 271.989px;">Delay before closing serial port in milliseconds</td><td style="height: 46px; width: 78.9915px;">No</td><td style="height: 46px; width: 108.977px;">10000</td><td style="height: 46px; width: 68.9915px;">  
</td><td style="height: 46px; width: 69.0057px;">  
</td></tr><tr style="height: 46px;"><td style="height: 46px; width: 130px;">poll\_delay\_ms</td><td style="height: 46px; width: 71.9744px;">integer</td><td style="height: 46px; width: 271.989px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="height: 46px; width: 78.9915px;">No</td><td style="height: 46px; width: 108.977px;">200</td><td style="height: 46px; width: 68.9915px;">  
</td><td style="height: 46px; width: 69.0057px;">  
</td></tr><tr style="height: 63px;"><td style="height: 63px; width: 130px;">timeout\_ms</td><td style="height: 63px; width: 71.9744px;">integer</td><td style="height: 63px; width: 271.989px;">Timeout of waiting for incoming request in  
milliseconds</td><td style="height: 63px; width: 78.9915px;">Yes</td><td style="height: 63px; width: 108.977px;">1000</td><td style="height: 63px; width: 68.9915px;">0</td><td style="height: 63px; width: 69.0057px;">60000</td></tr></tbody></table>

##### PowerOne parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 146px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 73px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 255px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 146px; height: 35px;">signal\_name</td><td style="width: 73px; height: 35px;">string

</td><td style="width: 255px; height: 35px;">User-­friendly signal name

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 146px; height: 35px;">device\_alias</td><td style="width: 73px; height: 35px;">string

</td><td style="width: 255px; height: 35px;">Device alias from a Devices tab

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 146px; height: 35px;">signal\_alias</td><td style="width: 73px; height: 35px;">string

</td><td style="width: 255px; height: 35px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 57px;"><td style="width: 146px; height: 57px;">enable</td><td style="width: 73px; height: 57px;">boolean

</td><td style="width: 255px; height: 57px;">Enabling/disabling of an individual signal

</td><td style="width: 79px; height: 57px;">No</td><td style="width: 109px; height: 57px;">1</td><td style="width: 69px; height: 57px;">0

</td><td style="width: 69px; height: 57px;">1

</td></tr><tr style="height: 35px;"><td style="width: 146px; height: 35px;">log</td><td style="width: 73px; height: 35px;">integer

</td><td style="width: 255px; height: 35px;">Enable logging in event log

</td><td style="width: 79px; height: 35px;">No</td><td style="width: 109px; height: 35px;">0</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 29px;"><td style="width: 146px; height: 29px;">number\_type</td><td style="width: 73px; height: 29px;">string</td><td style="width: 255px; height: 29px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 57px;"><td style="width: 146px; height: 57px;">job\_todo</td><td style="width: 73px; height: 57px;">string

</td><td style="width: 255px; height: 57px;">Tag job as single or multiple comma separated OBIS codes

</td><td style="width: 79px; height: 57px;">Yes</td><td style="width: 109px; height: 57px;">  
</td><td style="width: 69px; height: 57px;"></td><td style="width: 69px; height: 57px;"></td></tr><tr style="height: 29px;"><td style="width: 146px; height: 29px;">tag\_job\_todo</td><td style="width: 73px; height: 29px;">string</td><td style="width: 255px; height: 29px;">Tag sub job</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 46px;"><td style="width: 146px; height: 46px;">pulse\_short\_time\_ms</td><td style="width: 73px; height: 46px;">integer</td><td style="width: 255px; height: 46px;">Time interval for short output pulse to stay active </td><td style="width: 79px; height: 46px;">No</td><td style="width: 109px; height: 46px;">0</td><td style="width: 69px; height: 46px;">  
</td><td style="width: 69px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 146px; height: 46px;">pulse\_long\_time\_ms</td><td style="width: 73px; height: 46px;">integer</td><td style="width: 255px; height: 46px;">Time interval for long output pulse to stay active</td><td style="width: 79px; height: 46px;">No</td><td style="width: 109px; height: 46px;">0</td><td style="width: 69px; height: 46px;">  
</td><td style="width: 69px; height: 46px;">  
</td></tr></tbody></table>

# 16.8 SMA NET

### Overview

SMA Net can transfer SMA Data, TCP/IP and many more telegrams due to its multi­protocol capability. Thus, it is the preferred telegram frame in case of new developments.

### Configuration

##### SMA NET parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 49px;"><td style="width: 93px; height: 49px;">name</td><td style="width: 61px; height: 49px;">string </td><td style="width: 202px; height: 49px;">User-friendly device name</td><td style="width: 78px; height: 49px;">Yes</td><td style="width: 86px; height: 49px;"></td><td style="width: 141px; height: 49px;">  
</td><td style="width: 141px; height: 49px;"></td></tr><tr style="height: 35px;"><td style="width: 93px; height: 35px;">description</td><td style="width: 61px; height: 35px;">string</td><td style="width: 202px; height: 35px;">Description of a device</td><td style="width: 78px; height: 35px;">No</td><td style="width: 86px; height: 35px;"></td><td style="width: 141px; height: 35px;">  
</td><td style="width: 141px; height: 35px;"></td></tr><tr style="height: 46px;"><td style="width: 93px; height: 46px;">device\_alias</td><td style="width: 61px; height: 46px;">string</td><td style="width: 202px; height: 46px;">Alphanumeric string to identify a device</td><td style="width: 78px; height: 46px;">Yes</td><td style="width: 86px; height: 46px;">  
</td><td style="width: 141px; height: 46px;">  
</td><td style="width: 141px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 93px; height: 46px;">enable</td><td style="width: 61px; height: 46px;">boolean</td><td style="width: 202px; height: 46px;">Enabling/disabling of a device</td><td style="width: 78px; height: 46px;">No</td><td style="width: 86px; height: 46px;">1</td><td style="width: 141px; height: 46px;">0</td><td style="width: 141px; height: 46px;">1</td></tr><tr style="height: 35px;"><td style="width: 93px; height: 35px;">protocol</td><td style="width: 61px; height: 35px;">string</td><td style="width: 202px; height: 35px;">Protocol to be used.</td><td style="width: 78px; height: 35px;">Yes</td><td style="width: 86px; height: 35px;">  
</td><td colspan="2" style="width: 282px; height: 35px;">sma net

</td></tr><tr style="height: 46px;"><td style="width: 93px; height: 46px;">baudrate</td><td style="width: 61px; height: 46px;">integer</td><td style="width: 202px; height: 46px;">Communication speed (bauds/s)</td><td style="width: 78px; height: 46px;">No</td><td style="width: 86px; height: 46px;">9600</td><td colspan="2" style="height: 46px; width: 282px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">databits</td><td style="width: 61px; height: 29px;">integer</td><td style="width: 202px; height: 29px;">Data bit count for communication</td><td style="width: 78px; height: 29px;">No</td><td style="width: 86px; height: 29px;">8</td><td style="height: 29px; width: 141px;">6</td><td style="width: 141px;">9</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">stopbits</td><td style="width: 61px; height: 29px;">integer</td><td style="width: 202px; height: 29px;">Stop bit count for communication</td><td style="width: 78px; height: 29px;">No</td><td style="width: 86px; height: 29px;">1</td><td style="height: 29px; width: 141px;">1</td><td style="width: 141px;">2</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">parity</td><td style="width: 61px; height: 29px;">string</td><td style="width: 202px; height: 29px;">Communication parity option</td><td style="width: 78px; height: 29px;">No</td><td style="width: 86px; height: 29px;">none</td><td colspan="2" style="height: 29px; width: 141px;">none, even, odd</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">flowcontrol</td><td style="width: 61px; height: 29px;">string</td><td style="width: 202px; height: 29px;">Communication device flow control option.</td><td style="width: 78px; height: 29px;">No</td><td style="width: 86px; height: 29px;">none</td><td colspan="2" style="height: 29px; width: 141px;">none</td></tr><tr style="height: 46px;"><td style="width: 93px; height: 46px;">scan\_rate\_ms</td><td style="width: 61px; height: 46px;">integer</td><td style="width: 202px; height: 46px;">Delay before closing serial port in milliseconds</td><td style="width: 78px; height: 46px;">No</td><td style="width: 86px; height: 46px;">10000</td><td style="width: 141px; height: 46px;">  
</td><td style="width: 141px; height: 46px;">  
</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">poll\_delay\_ms</td><td style="width: 61px; height: 29px;">integer</td><td style="width: 202px; height: 29px;">  
</td><td style="width: 78px; height: 29px;">No</td><td style="width: 86px; height: 29px;">200</td><td style="width: 141px; height: 29px;">  
</td><td style="width: 141px; height: 29px;">  
</td></tr><tr style="height: 63px;"><td style="width: 93px; height: 63px;">timeout\_ms</td><td style="width: 61px; height: 63px;">integer</td><td style="width: 202px; height: 63px;">Timeout of waiting for incoming request in  
milliseconds</td><td style="width: 78px; height: 63px;">No</td><td style="width: 86px; height: 63px;">2500</td><td style="width: 141px; height: 63px;">  
</td><td style="width: 141px; height: 63px;">  
</td></tr><tr style="height: 46px;"><td style="width: 93px; height: 46px;">serial\_number</td><td style="width: 61px; height: 46px;"><div><div>string</div></div></td><td style="width: 202px; height: 46px;">Inverter serial number</td><td style="width: 78px; height: 46px;">Yes</td><td style="width: 86px; height: 46px;">  
</td><td style="width: 141px; height: 46px;">  
</td><td style="width: 141px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 93px; height: 46px;">device</td><td style="width: 61px; height: 46px;">  
</td><td style="width: 202px; height: 46px;">Communication port</td><td style="width: 78px; height: 46px;">Yes</td><td style="width: 86px; height: 46px;">  
</td><td style="width: 141px; height: 46px;">PORT1</td><td style="width: 141px; height: 46px;">PORT2</td></tr><tr style="height: 46px;"><td style="width: 93px; height: 46px;">serial\_close\_delay</td><td style="width: 61px; height: 46px;">integer</td><td style="width: 202px; height: 46px;">Delay before closing serial port</td><td style="width: 78px; height: 46px;">No</td><td style="width: 86px; height: 46px;">400</td><td style="width: 141px; height: 46px;">  
</td><td style="width: 141px; height: 46px;">  
</td></tr></tbody></table>

##### SMA NET parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 154px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 69px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 251px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 154px;">signal\_name</td><td style="height: 35px; width: 69px;">string

</td><td style="height: 35px; width: 251px;">User-­friendly signal name

</td><td style="height: 35px; width: 79px;">Yes</td><td style="height: 35px; width: 109px;">  
</td><td style="height: 35px; width: 69px;"></td><td style="height: 35px; width: 69px;"></td></tr><tr style="height: 35px;"><td style="height: 35px; width: 154px;">device\_alias</td><td style="height: 35px; width: 69px;">string

</td><td style="height: 35px; width: 251px;">Device alias from a Devices tab

</td><td style="height: 35px; width: 79px;">Yes</td><td style="height: 35px; width: 109px;">  
</td><td style="height: 35px; width: 69px;"></td><td style="height: 35px; width: 69px;"></td></tr><tr style="height: 35px;"><td style="height: 35px; width: 154px;">signal\_alias</td><td style="height: 35px; width: 69px;">string

</td><td style="height: 35px; width: 251px;">Unique alphanumeric name of the signal to be used

</td><td style="height: 35px; width: 79px;">Yes</td><td style="height: 35px; width: 109px;">  
</td><td style="height: 35px; width: 69px;"></td><td style="height: 35px; width: 69px;"></td></tr><tr style="height: 57px;"><td style="height: 57px; width: 154px;">enable</td><td style="height: 57px; width: 69px;">boolean

</td><td style="height: 57px; width: 251px;">Enabling/disabling of an individual signal

</td><td style="height: 57px; width: 79px;">No</td><td style="height: 57px; width: 109px;">1</td><td style="height: 57px; width: 69px;">0

</td><td style="height: 57px; width: 69px;">1

</td></tr><tr style="height: 57px;"><td style="height: 57px; width: 154px;">log</td><td style="height: 57px; width: 69px;">integer

</td><td style="height: 57px; width: 251px;">Enable logging in event log

</td><td style="height: 57px; width: 79px;">No</td><td style="height: 57px; width: 109px;">0</td><td style="height: 57px; width: 69px;"></td><td style="height: 57px; width: 69px;"></td></tr><tr style="height: 46px;"><td style="height: 46px; width: 154px;">number\_type</td><td style="height: 46px; width: 69px;">string</td><td style="height: 46px; width: 251px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="height: 46px; width: 79px;">Yes</td><td style="height: 46px; width: 109px;">  
</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr><tr style="height: 57px;"><td style="height: 57px; width: 154px;">job\_todo</td><td style="height: 57px; width: 69px;">string

</td><td style="height: 57px; width: 251px;">Tag job as single or multiple comma separated OBIS codes

</td><td style="height: 57px; width: 79px;">Yes</td><td style="height: 57px; width: 109px;">  
</td><td style="height: 57px; width: 69px;"></td><td style="height: 57px; width: 69px;"></td></tr><tr style="height: 46px;"><td style="height: 46px; width: 154px;">tag\_job\_todo</td><td style="height: 46px; width: 69px;">string</td><td style="height: 46px; width: 251px;">Tag sub job</td><td style="height: 46px; width: 79px;">Yes</td><td style="height: 46px; width: 109px;">  
</td><td style="height: 46px; width: 69px;">  
</td><td style="height: 46px; width: 69px;">  
</td></tr><tr style="height: 28px;"><td style="height: 28px; width: 154px;">pulse\_short\_time\_ms</td><td style="height: 28px; width: 69px;">integer</td><td style="height: 28px; width: 251px;">Time interval for short output pulse to stay active </td><td style="height: 28px; width: 79px;">No</td><td style="height: 28px; width: 109px;">0</td><td style="height: 28px; width: 69px;">  
</td><td style="height: 28px; width: 69px;">  
</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 154px;">pulse\_long\_time\_ms</td><td style="height: 29px; width: 69px;">integer</td><td style="height: 29px; width: 251px;">Time interval for long output pulse to stay active</td><td style="height: 29px; width: 79px;">No</td><td style="height: 29px; width: 109px;">0</td><td style="height: 29px; width: 69px;">  
</td><td style="height: 29px; width: 69px;">  
</td></tr></tbody></table>

# 16.9 SOLPLUS

### Overview

Solplus protocol is used to download inverter data from Solplus inverters using a HTTP client.

### Configuration

##### Solplus parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 133px; height: 35px;">name</td><td style="width: 71px; height: 35px;">string </td><td style="width: 275px; height: 35px;">User-friendly device name</td><td style="width: 77px; height: 35px;">Yes</td><td style="width: 108px; height: 35px;"></td><td style="width: 71px; height: 35px;">  
</td><td style="width: 71px; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 133px; height: 35px;">description</td><td style="width: 71px; height: 35px;">string</td><td style="width: 275px; height: 35px;">Description of a device</td><td style="width: 77px; height: 35px;">No</td><td style="width: 108px; height: 35px;"></td><td style="width: 71px; height: 35px;">  
</td><td style="width: 71px; height: 35px;"></td></tr><tr style="height: 29px;"><td style="width: 133px; height: 29px;">device\_alias</td><td style="width: 71px; height: 29px;">string</td><td style="width: 275px; height: 29px;">Alphanumeric string to identify a device</td><td style="width: 77px; height: 29px;">Yes</td><td style="width: 108px; height: 29px;">  
</td><td style="width: 71px; height: 29px;">  
</td><td style="width: 71px; height: 29px;">  
</td></tr><tr style="height: 45px;"><td style="width: 133px; height: 45px;">enable</td><td style="width: 71px; height: 45px;">boolean</td><td style="width: 275px; height: 45px;">Enabling/disabling of a device</td><td style="width: 77px; height: 45px;">No</td><td style="width: 108px; height: 45px;">1</td><td style="width: 71px; height: 45px;">0</td><td style="width: 71px; height: 45px;">1</td></tr><tr style="height: 35px;"><td style="width: 133px; height: 35px;">protocol</td><td style="width: 71px; height: 35px;">string</td><td style="width: 275px; height: 35px;">Protocol to be used.</td><td style="width: 77px; height: 35px;">Yes</td><td style="width: 108px; height: 35px;">  
</td><td colspan="2" style="width: 142px; height: 35px;">Solplus

</td></tr><tr style="height: 35px;"><td style="width: 133px; height: 35px;">scan\_rate\_ms</td><td style="width: 71px; height: 35px;">integer</td><td style="width: 275px; height: 35px;">All reads and writes will be executed within the timeframe in milliseconds</td><td style="width: 77px; height: 35px;">No</td><td style="width: 108px; height: 35px;">10000</td><td colspan="2" style="width: 142px; height: 35px;"></td></tr><tr style="height: 49px;"><td style="width: 133px; height: 49px;">poll\_delay\_ms</td><td style="width: 71px; height: 49px;">integer</td><td style="width: 275px; height: 49px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 77px; height: 49px;">No</td><td style="width: 108px; height: 49px;">200</td><td colspan="2" style="width: 142px; height: 49px;"></td></tr><tr style="height: 46px;"><td style="width: 133px; height: 46px;">timeout\_ms</td><td style="width: 71px; height: 46px;">integer</td><td style="width: 275px; height: 46px;">Timeout of waiting for incoming request in milliseconds</td><td style="width: 77px; height: 46px;">No</td><td style="width: 108px; height: 46px;">2500</td><td style="width: 71px; height: 46px;">0</td><td style="width: 71px; height: 46px;">60000</td></tr><tr style="height: 29px;"><td style="width: 133px; height: 29px;">url</td><td style="width: 71px; height: 29px;">string</td><td style="width: 275px; height: 29px;">HTTP server location URL</td><td style="width: 77px; height: 29px;">Yes</td><td style="width: 108px; height: 29px;">  
</td><td style="width: 71px; height: 29px;">  
</td><td style="width: 71px; height: 29px;">  
</td></tr></tbody></table>

##### Solplus parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 156px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 71px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 247px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 156px; height: 35px;">signal\_name</td><td style="width: 71px; height: 35px;">string

</td><td style="width: 247px; height: 35px;">User-­friendly signal name

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 156px; height: 35px;">device\_alias</td><td style="width: 71px; height: 35px;">string

</td><td style="width: 247px; height: 35px;">Device alias from a Devices tab

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 57px;"><td style="width: 156px; height: 57px;">signal\_alias</td><td style="width: 71px; height: 57px;">string

</td><td style="width: 247px; height: 57px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 79px; height: 57px;">Yes</td><td style="width: 109px; height: 57px;">  
</td><td style="width: 69px; height: 57px;"></td><td style="width: 69px; height: 57px;"></td></tr><tr style="height: 35px;"><td style="width: 156px; height: 35px;">enable</td><td style="width: 71px; height: 35px;">boolean

</td><td style="width: 247px; height: 35px;">Enabling/disabling of an individual signal

</td><td style="width: 79px; height: 35px;">No</td><td style="width: 109px; height: 35px;">1</td><td style="width: 69px; height: 35px;">0

</td><td style="width: 69px; height: 35px;">1

</td></tr><tr style="height: 35px;"><td style="width: 156px; height: 35px;">log</td><td style="width: 71px; height: 35px;">integer

</td><td style="width: 247px; height: 35px;">Enable logging in event log

</td><td style="width: 79px; height: 35px;">No</td><td style="width: 109px; height: 35px;">0</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 46px;"><td style="width: 156px; height: 46px;">number\_type</td><td style="width: 71px; height: 46px;">string</td><td style="width: 247px; height: 46px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 79px; height: 46px;">Yes</td><td style="width: 109px; height: 46px;">  
</td><td style="width: 69px; height: 46px;">  
</td><td style="width: 69px; height: 46px;">  
</td></tr><tr style="height: 57px;"><td style="width: 156px; height: 57px;">job\_todo</td><td style="width: 71px; height: 57px;">string

</td><td style="width: 247px; height: 57px;">Tag job as single or multiple comma separated OBIS codes

</td><td style="width: 79px; height: 57px;">Yes</td><td style="width: 109px; height: 57px;">  
</td><td style="width: 69px; height: 57px;"></td><td style="width: 69px; height: 57px;"></td></tr><tr style="height: 30px;"><td style="width: 156px; height: 30px;">tag\_job\_todo</td><td style="width: 71px; height: 30px;">string</td><td style="width: 247px; height: 30px;">Tag sub job</td><td style="width: 79px; height: 30px;">Yes</td><td style="width: 109px; height: 30px;">  
</td><td style="width: 69px; height: 30px;">  
</td><td style="width: 69px; height: 30px;">  
</td></tr><tr style="height: 12px;"><td style="width: 156px; height: 12px;">pulse\_short\_time\_ms</td><td style="width: 71px; height: 12px;">integer</td><td style="width: 247px; height: 12px;">Time interval for short output pulse to stay active</td><td style="width: 79px; height: 12px;">No</td><td style="width: 109px; height: 12px;">0</td><td style="width: 69px; height: 12px;">  
</td><td style="width: 69px; height: 12px;">  
</td></tr><tr style="height: 46px;"><td style="width: 156px; height: 46px;">pulse\_long\_time\_ms</td><td style="width: 71px; height: 46px;">integer</td><td style="width: 247px; height: 46px;">Time interval for long output pulse to stay active</td><td style="width: 79px; height: 46px;">No</td><td style="width: 109px; height: 46px;">0</td><td style="width: 69px; height: 46px;">  
</td><td style="width: 69px; height: 46px;">  
</td></tr></tbody></table>

# 16.10 VBUS

### Overview

Vbus is a protocol used for communication with solar station automation via serial link.

### Configuration

##### VBUS parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 97.3594px;">name</td><td style="width: 73.2656px;">string</td><td style="width: 242.906px;">User-friendly device name</td><td style="width: 71.2656px;">Yes</td><td style="width: 125.453px;">  
</td><td style="width: 96.3594px;">  
</td><td style="width: 96.3906px;">  
</td></tr><tr><td style="width: 97.3594px;">description</td><td style="width: 73.2656px;">string</td><td style="width: 242.906px;">Description of the device</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">  
</td><td style="width: 96.3594px;">  
</td><td style="width: 96.3906px;">  
</td></tr><tr><td style="width: 97.3594px;">device\_alias</td><td style="width: 73.2656px;">string</td><td style="width: 242.906px;">Device alias to be used in configuration</td><td style="width: 71.2656px;">Yes</td><td style="width: 125.453px;">  
</td><td style="width: 96.3594px;">  
</td><td style="width: 96.3906px;">  
</td></tr><tr><td style="width: 97.3594px;">enable</td><td style="width: 73.2656px;">boolean</td><td style="width: 242.906px;">Enabling/disabling of a device</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">1</td><td style="width: 96.3594px;">0</td><td style="width: 96.3906px;">1</td></tr><tr><td style="width: 97.3594px;">protocol</td><td style="width: 73.2656px;">string</td><td style="width: 242.906px;">Selection of protocol</td><td style="width: 71.2656px;">Yes</td><td style="width: 125.453px;">  
</td><td colspan="2" style="width: 192.75px;">Vbus</td></tr><tr><td style="width: 97.3594px;">slave\_address</td><td style="width: 73.2656px;">integer</td><td style="width: 242.906px;">Slave device address</td><td style="width: 71.2656px;">Yes</td><td style="width: 125.453px;">  
</td><td style="width: 96.3594px;">0</td><td style="width: 96.3906px;">255</td></tr><tr><td style="width: 97.3594px;">master\_address</td><td style="width: 73.2656px;">integer</td><td style="width: 242.906px;">Master device address</td><td style="width: 71.2656px;">Yes</td><td style="width: 125.453px;">  
</td><td style="width: 96.3594px;">0</td><td style="width: 96.3906px;">255</td></tr><tr><td style="width: 97.3594px;">device</td><td style="width: 73.2656px;">string</td><td style="width: 242.906px;">Communication port</td><td style="width: 71.2656px;">Yes</td><td style="width: 125.453px;">  
</td><td style="width: 96.3594px;">PORT1</td><td style="width: 96.3906px;">PORT2</td></tr><tr><td style="width: 97.3594px;">baudrate</td><td style="width: 73.2656px;">integer</td><td style="width: 242.906px;">Communication speed (bauds/s)</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">9600</td><td colspan="2" style="width: 192.75px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200</td></tr><tr><td style="width: 97.3594px;">databits</td><td style="width: 73.2656px;">integer</td><td style="width: 242.906px;">Data bit count for communication</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">8</td><td style="width: 96.3594px;">6</td><td style="width: 96.3906px;">9</td></tr><tr><td style="width: 97.3594px;">stopbits</td><td style="width: 73.2656px;">integer</td><td style="width: 242.906px;">Stop bit count for communication</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">1</td><td style="width: 96.3594px;">1</td><td style="width: 96.3906px;">2</td></tr><tr><td style="width: 97.3594px;">parity</td><td style="width: 73.2656px;">string</td><td style="width: 242.906px;">Communication parity option</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">none</td><td colspan="2" style="width: 192.75px;">none, even, odd</td></tr><tr><td style="width: 97.3594px;">flowcontrol</td><td style="width: 73.2656px;">string</td><td style="width: 242.906px;">Communication device flow control option.</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">none</td><td colspan="2" style="width: 192.75px;">none</td></tr><tr><td style="width: 97.3594px;">scan\_rate\_ms</td><td style="width: 73.2656px;">integer</td><td style="width: 242.906px;">If provided and positive ­ all reads and writes will be executed within the timeframe in milliseconds.</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">10000</td><td style="width: 96.3594px;">  
</td><td style="width: 96.3906px;">  
</td></tr><tr><td style="width: 97.3594px;">poll\_delay\_ms</td><td style="width: 73.2656px;">integer</td><td style="width: 242.906px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">200</td><td style="width: 96.3594px;">  
</td><td style="width: 96.3906px;">  
</td></tr><tr><td style="width: 97.3594px;">timeout\_ms</td><td style="width: 73.2656px;">integer</td><td style="width: 242.906px;">Timeout in milliseconds</td><td style="width: 71.2656px;">No</td><td style="width: 125.453px;">2500</td><td style="width: 96.3594px;">0</td><td style="width: 96.3906px;">60000</td></tr></tbody></table>

##### VBUS parameters for *Signals* tab:

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 137px;">signal\_name</td><td style="width: 64px;">string</td><td style="width: 326px;">User-friendly device name</td><td style="width: 84px;">Yes</td><td style="width: 115px;">  
</td><td style="width: 40px;">  
</td><td style="width: 43px;">  
</td></tr><tr><td style="width: 137px;">device\_alias</td><td style="width: 64px;">string</td><td style="width: 326px;">Device alias from a Devices tab</td><td style="width: 84px;">Yes</td><td style="width: 115px;">  
</td><td style="width: 40px;">  
</td><td style="width: 43px;">  
</td></tr><tr><td style="width: 137px;">signal\_alias</td><td style="width: 64px;">string</td><td style="width: 326px;">Unique alphanumeric name of the signal to be used</td><td style="width: 84px;">Yes</td><td style="width: 115px;">  
</td><td style="width: 40px;">  
</td><td style="width: 43px;">  
</td></tr><tr><td style="width: 137px;">enable</td><td style="width: 64px;">boolean</td><td style="width: 326px;">Enabling/disabling of an individual signal</td><td style="width: 84px;">No</td><td style="width: 115px;">1</td><td style="width: 40px;">0</td><td style="width: 43px;">1</td></tr><tr><td style="width: 137px;">log</td><td style="width: 64px;">integer</td><td style="width: 326px;">Allow signal to be logged.</td><td style="width: 84px;">No</td><td style="width: 115px;">0</td><td style="width: 40px;">0</td><td style="width: 43px;">  
</td></tr><tr><td style="width: 137px;">job\_todo</td><td style="width: 64px;"><div><div>string</div></div></td><td style="width: 326px;">Define tag­-function</td><td style="width: 84px;">Yes</td><td style="width: 115px;">  
</td><td style="width: 40px;">  
</td><td style="width: 43px;">  
</td></tr><tr><td style="width: 137px;">tag\_job\_todo</td><td style="width: 64px;">string</td><td style="width: 326px;">Define tag action that depends on tag function</td><td style="width: 84px;">Yes</td><td style="width: 115px;">  
</td><td style="width: 40px;">  
</td><td style="width: 43px;">  
</td></tr><tr><td style="width: 137px;">number\_type</td><td style="width: 64px;">string</td><td style="width: 326px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 84px;">Yes</td><td style="width: 115px;">  
</td><td style="width: 40px;">  
</td><td style="width: 43px;">  
</td></tr><tr><td style="width: 137px;">pulse\_short\_time\_ms</td><td style="width: 64px;">integer</td><td style="width: 326px;">Time interval for short output pulse to stay active</td><td style="width: 84px;">No</td><td style="width: 115px;">0</td><td style="width: 40px;">  
</td><td style="width: 43px;">  
</td></tr><tr><td style="width: 137px;">pulse\_long\_time\_ms</td><td style="width: 64px;">integer</td><td style="width: 326px;">Time interval for long output pulse to stay active</td><td style="width: 84px;">No</td><td style="width: 115px;">0</td><td style="width: 40px;">  
</td><td style="width: 43px;">  
</td></tr></tbody></table>

# 16.11 VESTAS

### Overview

Vestas is a protocol used for communication with solar station automation via serial link.

### Configuration

##### Vestas parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 96.3368px;">name</td><td style="width: 64.2188px;">string</td><td style="width: 236.84px;">User-friendly device name</td><td style="width: 84.2882px;">Yes</td><td style="width: 127.448px;">  
</td><td style="width: 97.3438px;">  
</td><td style="width: 97.4132px;">  
</td></tr><tr><td style="width: 96.3368px;">description</td><td style="width: 64.2188px;">string</td><td style="width: 236.84px;">Description of the device</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">  
</td><td style="width: 97.3438px;">  
</td><td style="width: 97.4132px;">  
</td></tr><tr><td style="width: 96.3368px;">device\_alias</td><td style="width: 64.2188px;">string</td><td style="width: 236.84px;">Device alias to be used in configuration</td><td style="width: 84.2882px;">Yes</td><td style="width: 127.448px;">  
</td><td style="width: 97.3438px;">  
</td><td style="width: 97.4132px;">  
</td></tr><tr><td style="width: 96.3368px;">enable</td><td style="width: 64.2188px;">boolean</td><td style="width: 236.84px;">Enabling/disabling of a device</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">1</td><td style="width: 97.3438px;">0</td><td style="width: 97.4132px;">1</td></tr><tr><td style="width: 96.3368px;">protocol</td><td style="width: 64.2188px;">string</td><td style="width: 236.84px;">Selection of protocol</td><td style="width: 84.2882px;">Yes</td><td style="width: 127.448px;">  
</td><td colspan="2" style="width: 194.757px;">Vestas</td></tr><tr><td style="width: 96.3368px;">slave\_address</td><td style="width: 64.2188px;">integer</td><td style="width: 236.84px;">Slave device address</td><td style="width: 84.2882px;">Yes</td><td style="width: 127.448px;">  
</td><td style="width: 97.3438px;">0</td><td style="width: 97.4132px;">255</td></tr><tr><td style="width: 96.3368px;">master\_address</td><td style="width: 64.2188px;">integer</td><td style="width: 236.84px;">Master device address</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">0</td><td style="width: 97.3438px;">0</td><td style="width: 97.4132px;">255</td></tr><tr><td style="width: 96.3368px;">device</td><td style="width: 64.2188px;">string</td><td style="width: 236.84px;">Communication port</td><td style="width: 84.2882px;">Yes</td><td style="width: 127.448px;">  
</td><td style="width: 97.3438px;">PORT1</td><td style="width: 97.4132px;">PORT2</td></tr><tr><td style="width: 96.3368px;">baudrate</td><td style="width: 64.2188px;">integer</td><td style="width: 236.84px;">Communication speed (bauds/s)</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">9600</td><td colspan="2" style="width: 194.757px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200</td></tr><tr><td style="width: 96.3368px;">databits</td><td style="width: 64.2188px;">integer</td><td style="width: 236.84px;">Data bit count for communication</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">8</td><td style="width: 97.3438px;">6</td><td style="width: 97.4132px;">9</td></tr><tr><td style="width: 96.3368px;">stopbits</td><td style="width: 64.2188px;">integer</td><td style="width: 236.84px;">Stop bit count for communication</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">1</td><td style="width: 97.3438px;">1</td><td style="width: 97.4132px;">2</td></tr><tr><td style="width: 96.3368px;">parity</td><td style="width: 64.2188px;">string</td><td style="width: 236.84px;">Communication parity option  
(”none”/”even”/”odd”)</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">none</td><td colspan="2" style="width: 97.3438px;">none, even, odd</td></tr><tr><td style="width: 96.3368px;">flowcontrol</td><td style="width: 64.2188px;">string</td><td style="width: 236.84px;">Communication device flow control option. (Default: (case-sensitive): ”none”)</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">none</td><td style="width: 97.3438px;">  
</td><td style="width: 97.4132px;">  
</td></tr><tr><td style="width: 96.3368px;">scan\_rate\_ms</td><td style="width: 64.2188px;">integer</td><td style="width: 236.84px;">If provided and positive ­ all reads and writes will be executed within the timeframe in milliseconds.</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">10000</td><td style="width: 97.3438px;">  
</td><td style="width: 97.4132px;">  
</td></tr><tr><td style="width: 96.3368px;">poll\_delay\_ms</td><td style="width: 64.2188px;">integer</td><td style="width: 236.84px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;">200</td><td style="width: 97.3438px;">  
</td><td style="width: 97.4132px;">  
</td></tr><tr><td style="width: 96.3368px;">timeout\_ms</td><td style="width: 64.2188px;">integer</td><td style="width: 236.84px;">Timeout in milliseconds</td><td style="width: 84.2882px;">No</td><td style="width: 127.448px;"><div><div>500</div></div></td><td style="width: 97.3438px;"><div><div>0</div></div></td><td style="width: 97.4132px;"><div><div>60000</div></div></td></tr></tbody></table>

##### Vestas parameters for *Signals* tab:

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 150px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 68px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 256px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 150px;">signal\_name</td><td style="width: 68px;">string</td><td style="width: 256px;">User-friendly device name</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 150px;">device\_alias</td><td style="width: 68px;">string</td><td style="width: 256px;">Device alias from a Devices tab</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 150px;">signal\_alias</td><td style="width: 68px;">string</td><td style="width: 256px;">Unique alphanumeric name of the signal to be used</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 150px;">enable</td><td style="width: 68px;">boolean</td><td style="width: 256px;">Enabling/disabling of an individual signal</td><td style="width: 79px;">No</td><td style="width: 109px;">1</td><td style="width: 69px;">0</td><td style="width: 69px;">1</td></tr><tr><td style="width: 150px;">log</td><td style="width: 68px;">integer</td><td style="width: 256px;">Allow signal to be logged.</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 150px;">job\_todo</td><td style="width: 68px;"><div><div>string</div></div></td><td style="width: 256px;">Define tag­-function</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 150px;">tag\_job\_todo</td><td style="width: 68px;">string</td><td style="width: 256px;">Define tag action that depends on tag function</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 150px;">number\_type</td><td style="width: 68px;">string</td><td style="width: 256px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 79px;">Yes</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 150px;">pulse\_short\_time\_ms</td><td style="width: 68px;">integer</td><td style="width: 256px;">Time interval for short output pulse to stay active</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 150px;">pulse\_long\_time\_ms</td><td style="width: 68px;">integer</td><td style="width: 256px;">Time interval for long output pulse to stay active</td><td style="width: 79px;">No</td><td style="width: 109px;">0</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr></tbody></table>

# 16.12 Windlog

### Overview

Windlog protocol is used for communications with the *Windlog data logger*.

### Configuration

##### Windlog parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 92.3264px;">name</td><td style="width: 53.1771px;">string </td><td style="width: 211.753px;">User-friendly device name</td><td style="width: 60.2083px;">Yes</td><td style="width: 103.351px;"></td><td style="width: 143.507px;">  
</td><td style="width: 143.559px;"></td></tr><tr><td style="width: 92.3264px;">description</td><td style="width: 53.1771px;">string</td><td style="width: 211.753px;">Description of a device</td><td style="width: 60.2083px;">No</td><td style="width: 103.351px;"></td><td style="width: 143.507px;">  
</td><td style="width: 143.559px;"></td></tr><tr><td style="width: 92.3264px;">device\_alias</td><td style="width: 53.1771px;">string</td><td style="width: 211.753px;">Alphanumeric string to identify a device</td><td style="width: 60.2083px;">Yes</td><td style="width: 103.351px;">  
</td><td style="width: 143.507px;">  
</td><td style="width: 143.559px;">  
</td></tr><tr><td style="width: 92.3264px;">enable</td><td style="width: 53.1771px;">boolean</td><td style="width: 211.753px;">Enabling/disabling of a device</td><td style="width: 60.2083px;">No</td><td style="width: 103.351px;">1</td><td style="width: 143.507px;">0</td><td style="width: 143.559px;">1</td></tr><tr><td style="width: 92.3264px;">protocol</td><td style="width: 53.1771px;">string</td><td style="width: 211.753px;">Protocol to be used.</td><td style="width: 60.2083px;">Yes</td><td style="width: 103.351px;">  
</td><td colspan="2" style="width: 287.066px;">Windlog

</td></tr><tr><td style="width: 92.3264px;">device</td><td style="width: 53.1771px;">string</td><td style="width: 211.753px;">Communication port</td><td style="width: 60.2083px;">Yes</td><td style="width: 103.351px;">  
</td><td style="width: 143.507px;">PORT1</td><td style="width: 143.559px;">PORT2</td></tr><tr><td style="width: 92.3264px;">baudrate</td><td style="width: 53.1771px;">integer</td><td style="width: 211.753px;">Communication speed (bauds/s)</td><td style="width: 60.2083px;">No</td><td style="width: 103.351px;">115200</td><td colspan="2" style="width: 287.066px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200</td></tr><tr><td style="width: 92.3264px;">databits</td><td style="width: 53.1771px;">integer</td><td style="width: 211.753px;">Data bit count for communication</td><td style="width: 60.2083px;">No</td><td style="width: 103.351px;">8</td><td style="width: 143.507px;">6</td><td style="width: 143.559px;">9</td></tr><tr><td style="width: 92.3264px;">stopbits</td><td style="width: 53.1771px;">integer</td><td style="width: 211.753px;">Stop bit count for communication</td><td style="width: 60.2083px;">No</td><td style="width: 103.351px;">1</td><td style="width: 143.507px;">1</td><td style="width: 143.559px;">2</td></tr><tr><td style="width: 92.3264px;">parity</td><td style="width: 53.1771px;">string</td><td style="width: 211.753px;">Communication parity option</td><td style="width: 60.2083px;">No</td><td style="width: 103.351px;">none</td><td style="width: 143.507px;">none, even, odd</td><td style="width: 143.559px;">  
</td></tr><tr><td style="width: 92.3264px;">flowcontrol</td><td style="width: 53.1771px;">string</td><td style="width: 211.753px;">Communication device flow control option.</td><td style="width: 60.2083px;">No</td><td style="width: 103.351px;">none</td><td style="width: 143.507px;">none</td><td style="width: 143.559px;">  
</td></tr><tr><td style="width: 92.3264px;">timeout\_ms</td><td style="width: 53.1771px;">integer</td><td style="width: 211.753px;">Timeout of waiting for incoming request in milliseconds</td><td style="width: 60.2083px;">Yes</td><td style="width: 103.351px;">  
</td><td style="width: 143.507px;">0</td><td style="width: 143.559px;">60000</td></tr><tr><td style="width: 92.3264px;">serial\_close\_delay</td><td style="width: 53.1771px;">integer</td><td style="width: 211.753px;">Delay before closing serial port</td><td style="width: 60.2083px;">No</td><td style="width: 103.351px;">400</td><td style="width: 143.507px;">  
</td><td style="width: 143.559px;">  
</td></tr></tbody></table>

##### Windlog parameters for the *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr><td style="width: 97px;">signal\_name</td><td style="width: 71px;">string

</td><td style="width: 329px;">User-­friendly signal name

</td><td style="width: 113px;">Yes</td><td style="width: 130px;">  
</td><td style="width: 39px;"></td><td style="width: 30px;"></td></tr><tr><td style="width: 97px;">device\_alias</td><td style="width: 71px;">string

</td><td style="width: 329px;">Device alias from a Devices tab

</td><td style="width: 113px;">Yes</td><td style="width: 130px;">  
</td><td style="width: 39px;"></td><td style="width: 30px;"></td></tr><tr><td style="width: 97px;">signal\_alias</td><td style="width: 71px;">string

</td><td style="width: 329px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 113px;">Yes</td><td style="width: 130px;">  
</td><td style="width: 39px;"></td><td style="width: 30px;"></td></tr><tr><td style="width: 97px;">enable</td><td style="width: 71px;">boolean

</td><td style="width: 329px;">Enabling/disabling an individual signal

</td><td style="width: 113px;">No</td><td style="width: 130px;">1</td><td style="width: 39px;">0

</td><td style="width: 30px;">1

</td></tr><tr><td style="width: 97px;">log</td><td style="width: 71px;">integer

</td><td style="width: 329px;">Enable logging in the event log

</td><td style="width: 113px;">No</td><td style="width: 130px;">0</td><td style="width: 39px;"></td><td style="width: 30px;"></td></tr><tr><td style="width: 97px;">number\_type</td><td style="width: 71px;">string</td><td style="width: 329px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 113px;">Yes</td><td style="width: 130px;">  
</td><td style="width: 39px;">  
</td><td style="width: 30px;">  
</td></tr><tr><td style="width: 97px;">job\_todo</td><td style="width: 71px;">string

</td><td style="width: 329px;">Tag job as single or multiple comma-separated OBIS codes

</td><td style="width: 113px;">Yes</td><td style="width: 130px;">  
</td><td style="width: 39px;"></td><td style="width: 30px;"></td></tr><tr><td style="width: 97px;">tag\_job\_todo</td><td style="width: 71px;">string</td><td style="width: 329px;">Tag sub job</td><td style="width: 113px;">Yes</td><td style="width: 130px;">  
</td><td style="width: 39px;">  
</td><td style="width: 30px;">  
</td></tr></tbody></table>

# 16.13 M-Bus

### Overview

M-Bus or Meter-Bus is a protocol for the remote reading of water, gas, or electricity meters. M-Bus is also usable for other types of consumption meters, such as heating systems or water meters. The M-Bus interface is made for communication on two wires, making it cost-effective. M-bus over TCP is also supported. When configured, meters will deliver the data they have collected to a WCC Lite RTU that is connected at periodic intervals (scan\_rate\_ms) to read all utility meters.

### Configuration

##### M-Bus parameters for *Device* tab

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 1584.12px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 15.6945%; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 8.64844%; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 28.9195%; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 12.8522%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 11.8636%; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 21.997%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 6.4261%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 6.4261%; height: 30.0938px;">RTU</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Min</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Max</th></tr><tr style="height: 35.4688px;"><td style="width: 15.6945%; height: 35.4688px;">name</td><td style="width: 8.64844%; height: 35.4688px;">string </td><td style="width: 28.9195%; height: 35.4688px;">User-friendly device name</td><td style="width: 6.4261%; height: 35.4688px;">Yes</td><td style="width: 6.4261%; height: 35.4688px;">Yes</td><td style="width: 11.8636%; height: 35.4688px;"></td><td style="width: 10.9985%; height: 35.4688px;">  
</td><td style="width: 10.9985%; height: 35.4688px;"></td></tr><tr style="height: 35.4688px;"><td style="width: 15.6945%; height: 35.4688px;">description</td><td style="width: 8.64844%; height: 35.4688px;">string</td><td style="width: 28.9195%; height: 35.4688px;">Description of a device</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 11.8636%; height: 35.4688px;"></td><td style="width: 10.9985%; height: 35.4688px;">  
</td><td style="width: 10.9985%; height: 35.4688px;"></td></tr><tr style="height: 46.6667px;"><td style="width: 15.6945%; height: 46.6667px;">device\_alias</td><td style="width: 8.64844%; height: 46.6667px;">string</td><td style="width: 28.9195%; height: 46.6667px;">Alphanumeric string to identify a device</td><td style="width: 6.4261%; height: 46.6667px;">Yes</td><td style="width: 6.4261%; height: 35.4688px;">Yes</td><td style="width: 11.8636%; height: 46.6667px;">  
</td><td style="width: 10.9985%; height: 46.6667px;">  
</td><td style="width: 10.9985%; height: 46.6667px;">  
</td></tr><tr style="height: 46.6667px;"><td style="width: 15.6945%; height: 46.6667px;">enable</td><td style="width: 8.64844%; height: 46.6667px;">boolean</td><td style="width: 28.9195%; height: 46.6667px;">Enabling/disabling a device</td><td style="width: 6.4261%; height: 46.6667px;">No</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 11.8636%; height: 46.6667px;">1</td><td style="width: 10.9985%; height: 46.6667px;">0</td><td style="width: 10.9985%; height: 46.6667px;">1</td></tr><tr style="height: 35.4688px;"><td style="width: 15.6945%; height: 35.4688px;">protocol</td><td style="width: 8.64844%; height: 35.4688px;">string</td><td style="width: 28.9195%; height: 35.4688px;">Protocol to be used.</td><td style="width: 6.4261%; height: 35.4688px;">Yes</td><td style="width: 6.4261%; height: 35.4688px;">Yes</td><td style="width: 11.8636%; height: 35.4688px;">  
</td><td colspan="2" style="width: 21.997%; height: 35.4688px;">mbus serial, mbus tcp</td></tr><tr style="height: 49.8785px;"><td style="width: 15.6945%; height: 49.8785px;">scan\_rate\_ms</td><td style="width: 8.64844%; height: 49.8785px;">integer</td><td style="width: 28.9195%; height: 49.8785px;">All reads and writes will be executed within the timeframe in milliseconds.</td><td style="width: 6.4261%; height: 49.8785px;">No</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 11.8636%; height: 49.8785px;">10000</td><td colspan="2" style="width: 21.997%; height: 49.8785px;"></td></tr><tr style="height: 48.8889px;"><td style="width: 15.6945%; height: 48.8889px;">poll\_delay\_ms</td><td style="width: 8.64844%; height: 48.8889px;">integer</td><td style="width: 28.9195%; height: 48.8889px;">Minimum time delay in milliseconds to wait  
before sending any data on port.</td><td style="width: 6.4261%; height: 48.8889px;">No</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 11.8636%; height: 48.8889px;">200</td><td colspan="2" style="width: 21.997%; height: 48.8889px;"></td></tr><tr style="height: 46.6667px;"><td style="width: 15.6945%; height: 46.6667px;">timeout\_ms</td><td style="width: 8.64844%; height: 46.6667px;">integer</td><td style="width: 28.9195%; height: 46.6667px;">Timeout of waiting for an incoming response in milliseconds</td><td style="width: 6.4261%; height: 46.6667px;">Yes</td><td style="width: 6.4261%; height: 35.4688px;">Yes</td><td style="width: 11.8636%; height: 46.6667px;">  
</td><td style="width: 10.9985%; height: 46.6667px;">0</td><td style="width: 10.9985%; height: 46.6667px;">60000</td></tr><tr style="height: 34.6528px;"><td style="width: 15.6945%; height: 34.6528px;">address</td><td style="width: 8.64844%; height: 34.6528px;">string</td><td style="width: 28.9195%; height: 34.6528px;">Device address</td><td style="width: 6.4261%; height: 34.6528px;">Yes</td><td style="width: 6.4261%; height: 35.4688px;">Yes</td><td style="width: 11.8636%; height: 34.6528px;">  
</td><td style="width: 10.9985%; height: 34.6528px;">  
</td><td style="width: 10.9985%; height: 34.6528px;">  
</td></tr><tr style="height: 46.6667px;"><td style="width: 15.6945%; height: 46.6667px;">device</td><td style="width: 8.64844%; height: 46.6667px;">string</td><td style="width: 28.9195%; height: 46.6667px;">Communication port</td><td style="width: 6.4261%; height: 46.6667px;">-</td><td style="width: 6.4261%; height: 35.4688px;">Yes</td><td style="width: 11.8636%; height: 46.6667px;">  
</td><td style="width: 10.9985%; height: 46.6667px;">PORT1</td><td style="width: 10.9985%; height: 46.6667px;">PORT2</td></tr><tr style="height: 80.2257px;"><td style="width: 15.6945%; height: 80.2257px;">baudrate</td><td style="width: 8.64844%; height: 80.2257px;">integer</td><td style="width: 28.9195%; height: 80.2257px;">Communication speed (baud/s)

</td><td style="width: 6.4261%; height: 80.2257px;">-

</td><td style="width: 6.4261%; height: 35.4688px;">No

</td><td style="width: 11.8636%; height: 80.2257px;">9600

</td><td colspan="2" style="width: 21.997%; height: 80.2257px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

</td></tr><tr style="height: 57.8472px;"><td style="width: 15.6945%; height: 57.8472px;">databits</td><td style="width: 8.64844%; height: 57.8472px;">integer</td><td style="width: 28.9195%; height: 57.8472px;">Data bit count for communication

</td><td style="width: 6.4261%; height: 57.8472px;">-

</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 11.8636%; height: 57.8472px;">8

</td><td style="width: 10.9985%; height: 57.8472px;">6

</td><td style="width: 10.9985%; height: 57.8472px;">9

</td></tr><tr style="height: 57.8472px;"><td style="width: 15.6945%; height: 57.8472px;">stopbits</td><td style="width: 8.64844%; height: 57.8472px;">integer</td><td style="width: 28.9195%; height: 57.8472px;">Stop bit count for communication

</td><td style="width: 6.4261%; height: 57.8472px;">-

</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 11.8636%; height: 57.8472px;">1

</td><td style="width: 10.9985%; height: 57.8472px;">1

</td><td style="width: 10.9985%; height: 57.8472px;">2

</td></tr><tr style="height: 57.8472px;"><td style="width: 15.6945%; height: 57.8472px;">parity</td><td style="width: 8.64844%; height: 57.8472px;">string

</td><td style="width: 28.9195%; height: 57.8472px;">Communication parity option

</td><td style="width: 6.4261%; height: 57.8472px;">-

</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 11.8636%; height: 57.8472px;">none

</td><td colspan="2" style="width: 21.997%; height: 57.8472px;">none, even, odd

</td></tr><tr style="height: 46.6667px;"><td style="width: 15.6945%; height: 46.6667px;"><div><div><div><div>serial_close_delay</div></div></div></div></td><td style="width: 8.64844%; height: 46.6667px;">integer</td><td style="width: 28.9195%; height: 46.6667px;">Delay before closing the serial connection.</td><td style="width: 6.4261%; height: 46.6667px;">-</td><td style="width: 6.4261%; height: 35.4688px;">No</td><td style="width: 11.8636%; height: 46.6667px;">400</td><td style="width: 10.9985%; height: 46.6667px;">  
</td><td style="width: 10.9985%; height: 46.6667px;">  
</td></tr><tr style="height: 46.6667px;"><td style="width: 15.6945%; height: 46.6667px;">ip</td><td style="width: 8.64844%; height: 46.6667px;">string</td><td style="width: 28.9195%; height: 46.6667px;">The IP address of the TCP slave device</td><td style="width: 6.4261%; height: 46.6667px;">Yes</td><td style="width: 6.4261%; height: 35.4688px;">-</td><td style="width: 11.8636%; height: 46.6667px;">  
</td><td style="width: 10.9985%; height: 46.6667px;">  
</td><td style="width: 10.9985%; height: 46.6667px;">  
</td></tr><tr style="height: 10px;"><td style="width: 15.6945%; height: 10px;">port</td><td style="width: 8.64844%; height: 10px;">integer</td><td style="width: 28.9195%; height: 10px;">TCP communication port

</td><td style="width: 6.4261%; height: 10px;">Yes

</td><td style="width: 6.4261%; height: 35.4688px;">-</td><td style="width: 11.8636%; height: 10px;"></td><td style="width: 10.9985%; height: 10px;">0</td><td style="width: 10.9985%; height: 10px;">65535</td></tr></tbody></table>

##### M-Bus parameters for the *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr-0" style="border-collapse: collapse; width: 100%; height: 584.12px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 12.4815%; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 9.76273%; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 31.0183%; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 12.728%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 11.8642%; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 21.997%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 6.05536%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 6.67265%; height: 30.0938px;">RTU</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Min</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Max</th></tr><tr style="height: 35.4688px;"><td style="width: 16.319%; height: 35.4688px;">signal\_name</td><td style="width: 7.78863%; height: 35.4688px;">string

</td><td style="width: 42.0339%; height: 35.4688px;">User-­friendly signal name

</td><td style="width: 10.2612%; height: 35.4688px;">Yes</td><td style="width: 8.40659%; height: 35.4688px;">Yes</td><td style="width: 13.9701%; height: 35.4688px;">  
</td><td style="width: 4.6979%; height: 35.4688px;"></td><td style="width: 4.6979%; height: 35.4688px;"></td></tr><tr style="height: 35.4688px;"><td style="width: 16.319%; height: 35.4688px;">device\_alias</td><td style="width: 7.78863%; height: 35.4688px;">string

</td><td style="width: 42.0339%; height: 35.4688px;">Device alias from a Devices tab

</td><td style="width: 10.2612%; height: 35.4688px;">Yes</td><td style="width: 8.40659%; height: 35.4688px;">Yes</td><td style="width: 13.9701%; height: 35.4688px;">  
</td><td style="width: 4.6979%; height: 35.4688px;"></td><td style="width: 4.6979%; height: 35.4688px;"></td></tr><tr style="height: 35.4688px;"><td style="width: 16.319%; height: 35.4688px;">signal\_alias</td><td style="width: 7.78863%; height: 35.4688px;">string

</td><td style="width: 42.0339%; height: 35.4688px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 10.2612%; height: 35.4688px;">Yes</td><td style="width: 8.40659%; height: 35.4688px;">Yes</td><td style="width: 13.9701%; height: 35.4688px;">  
</td><td style="width: 4.6979%; height: 35.4688px;"></td><td style="width: 4.6979%; height: 35.4688px;"></td></tr><tr style="height: 57.8472px;"><td style="width: 16.319%; height: 57.8472px;">enable</td><td style="width: 7.78863%; height: 57.8472px;">boolean

</td><td style="width: 42.0339%; height: 57.8472px;">Enabling/disabling of an individual signal

</td><td style="width: 10.2612%; height: 57.8472px;">No</td><td style="width: 8.40659%; height: 35.4688px;">No</td><td style="width: 13.9701%; height: 57.8472px;">1</td><td style="width: 4.6979%; height: 57.8472px;">0

</td><td style="width: 4.6979%; height: 57.8472px;">1

</td></tr><tr style="height: 35.4688px;"><td style="width: 16.319%; height: 35.4688px;">log</td><td style="width: 7.78863%; height: 35.4688px;">integer

</td><td style="width: 42.0339%; height: 35.4688px;">Enable logging in the event log

</td><td style="width: 10.2612%; height: 35.4688px;">No</td><td style="width: 4.6979%; height: 35.4688px;">No</td><td style="width: 13.9701%; height: 35.4688px;">0</td><td style="width: 4.6979%; height: 35.4688px;"></td><td style="width: 4.6979%; height: 35.4688px;"></td></tr><tr style="height: 29.8785px;"><td style="width: 16.319%; height: 29.8785px;">number\_type</td><td style="width: 7.78863%; height: 29.8785px;">string</td><td style="width: 42.0339%; height: 29.8785px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 10.2612%; height: 29.8785px;">Yes</td><td style="width: 4.6979%; height: 35.4688px;">Yes</td><td style="width: 13.9701%; height: 29.8785px;">  
</td><td style="width: 4.6979%; height: 29.8785px;">  
</td><td style="width: 4.6979%; height: 29.8785px;">  
</td></tr><tr style="height: 57.8472px;"><td style="width: 16.319%; height: 57.8472px;">job\_todo</td><td style="width: 7.78863%; height: 57.8472px;">string

</td><td style="width: 42.0339%; height: 57.8472px;">Tag job as single or multiple comma-separated OBIS codes

</td><td style="width: 10.2612%; height: 57.8472px;">Yes</td><td style="width: 4.6979%; height: 35.4688px;">Yes</td><td style="width: 13.9701%; height: 57.8472px;">  
</td><td style="width: 4.6979%; height: 57.8472px;"></td><td style="width: 4.6979%; height: 57.8472px;"></td></tr><tr style="height: 29.8785px;"><td style="width: 16.319%; height: 29.8785px;">tag\_job\_todo</td><td style="width: 7.78863%; height: 29.8785px;">string</td><td style="width: 42.0339%; height: 29.8785px;">Tag sub job</td><td style="width: 10.2612%; height: 29.8785px;">Yes</td><td style="width: 4.6979%; height: 35.4688px;">Yes</td><td style="width: 13.9701%; height: 29.8785px;">  
</td><td style="width: 4.6979%; height: 29.8785px;">  
</td><td style="width: 4.6979%; height: 29.8785px;">  
</td></tr></tbody></table>

# 16.14 KOSTAL

### Overview

Kostal protocol is used to communicate with Kostal devices over serial communication.

### Configuration

##### Kostal parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 108px; height: 35px;">name</td><td style="width: 84px; height: 35px;">string </td><td style="width: 293px; height: 35px;">User-friendly device name</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;"></td><td style="width: 91px; height: 35px;">  
</td><td style="width: 91px; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 108px; height: 35px;">description</td><td style="width: 84px; height: 35px;">string</td><td style="width: 293px; height: 35px;">Description of a device</td><td style="width: 79px; height: 35px;">No</td><td style="width: 109px; height: 35px;"></td><td style="width: 91px; height: 35px;">  
</td><td style="width: 91px; height: 35px;"></td></tr><tr style="height: 29px;"><td style="width: 108px; height: 29px;">device\_alias</td><td style="width: 84px; height: 29px;">string</td><td style="width: 293px; height: 29px;">Alphanumeric string to identify a device</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 91px; height: 29px;">  
</td><td style="width: 91px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 108px; height: 29px;">enable</td><td style="width: 84px; height: 29px;">boolean</td><td style="width: 293px; height: 29px;">Enabling/disabling of a device</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">1</td><td style="width: 91px; height: 29px;">0</td><td style="width: 91px; height: 29px;">1</td></tr><tr style="height: 35px;"><td style="width: 108px; height: 35px;">protocol</td><td style="width: 84px; height: 35px;">string</td><td style="width: 293px; height: 35px;">Protocol to be used.</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td colspan="2" style="width: 182px; height: 35px;">kostal

</td></tr><tr style="height: 29px;"><td style="width: 108px; height: 29px;">id</td><td style="width: 84px; height: 29px;">integer</td><td style="width: 293px; height: 29px;">Kostal device id</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 91px; height: 29px;">  
</td><td style="width: 91px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 108px; height: 29px;">device</td><td style="width: 84px; height: 29px;">  
</td><td style="width: 293px; height: 29px;">Communication port</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 91px; height: 29px;">PORT1</td><td style="width: 91px; height: 29px;">PORT2</td></tr><tr style="height: 63px;"><td style="width: 108px; height: 63px;">baudrate</td><td style="width: 84px; height: 63px;">integer</td><td style="width: 293px; height: 63px;">Communication speed (bauds/s)</td><td style="width: 79px; height: 63px;">No</td><td style="width: 109px; height: 63px;">9600</td><td colspan="2" style="width: 182px; height: 63px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200</td></tr><tr style="height: 29px;"><td style="width: 108px; height: 29px;">databits</td><td style="width: 84px; height: 29px;">integer</td><td style="width: 293px; height: 29px;">Data bit count for communication</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">8</td><td style="width: 91px; height: 29px;">6</td><td style="width: 91px; height: 29px;">9</td></tr><tr style="height: 29px;"><td style="width: 108px; height: 29px;">stopbits</td><td style="width: 84px; height: 29px;">integer</td><td style="width: 293px; height: 29px;">Stop bit count for communication</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">1</td><td style="width: 91px; height: 29px;">1</td><td style="width: 91px; height: 29px;">2</td></tr><tr style="height: 29px;"><td style="width: 108px; height: 29px;">parity</td><td style="width: 84px; height: 29px;">string</td><td style="width: 293px; height: 29px;">Communication parity option</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">none</td><td colspan="2" style="width: 182px; height: 29px;">none, even, odd</td></tr><tr style="height: 46px;"><td style="width: 108px; height: 46px;">scan\_rate\_ms</td><td style="width: 84px; height: 46px;">integer</td><td style="width: 293px; height: 46px;">Delay before closing serial port in milliseconds</td><td style="width: 79px; height: 46px;">No</td><td style="width: 109px; height: 46px;">10000</td><td style="width: 91px; height: 46px;">  
</td><td style="width: 91px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 108px; height: 46px;">poll\_delay\_ms</td><td style="width: 84px; height: 46px;">integer</td><td style="width: 293px; height: 46px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 79px; height: 46px;">No</td><td style="width: 109px; height: 46px;">200</td><td style="width: 91px; height: 46px;">  
</td><td style="width: 91px; height: 46px;">  
</td></tr><tr style="height: 63px;"><td style="width: 108px; height: 63px;">timeout\_ms</td><td style="width: 84px; height: 63px;">integer</td><td style="width: 293px; height: 63px;">Timeout of waiting for incoming request in  
milliseconds</td><td style="width: 79px; height: 63px;">Yes</td><td style="width: 109px; height: 63px;">  
</td><td style="width: 91px; height: 63px;">0</td><td style="width: 91px; height: 63px;">60000</td></tr></tbody></table>

##### Kostal parameters for *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 154px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 69px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 251px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 154px; height: 35px;">signal\_name</td><td style="width: 69px; height: 35px;">string

</td><td style="width: 251px; height: 35px;">User-­friendly signal name

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 154px; height: 35px;">device\_alias</td><td style="width: 69px; height: 35px;">string

</td><td style="width: 251px; height: 35px;">Device alias from a Devices tab

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 154px; height: 35px;">signal\_alias</td><td style="width: 69px; height: 35px;">string

</td><td style="width: 251px; height: 35px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 35px;">  
</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 154px; height: 35px;">enable</td><td style="width: 69px; height: 35px;">boolean

</td><td style="width: 251px; height: 35px;">Enabling/disabling of an individual signal

</td><td style="width: 79px; height: 35px;">No</td><td style="width: 109px; height: 35px;">1</td><td style="width: 69px; height: 35px;">0

</td><td style="width: 69px; height: 35px;">1

</td></tr><tr style="height: 35px;"><td style="width: 154px; height: 35px;">log</td><td style="width: 69px; height: 35px;">integer

</td><td style="width: 251px; height: 35px;">Enable logging in event log

</td><td style="width: 79px; height: 35px;">No</td><td style="width: 109px; height: 35px;">0</td><td style="width: 69px; height: 35px;"></td><td style="width: 69px; height: 35px;"></td></tr><tr style="height: 29px;"><td style="width: 154px; height: 29px;">number\_type</td><td style="width: 69px; height: 29px;">string</td><td style="width: 251px; height: 29px;">Type of a number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 57px;"><td style="width: 154px; height: 57px;">job\_todo</td><td style="width: 69px; height: 57px;">string

</td><td style="width: 251px; height: 57px;">Tag job as single or multiple comma separated OBIS codes

</td><td style="width: 79px; height: 57px;">Yes</td><td style="width: 109px; height: 57px;">  
</td><td style="width: 69px; height: 57px;"></td><td style="width: 69px; height: 57px;"></td></tr><tr style="height: 29px;"><td style="width: 154px; height: 29px;">tag\_job\_todo</td><td style="width: 69px; height: 29px;">string</td><td style="width: 251px; height: 29px;">Tag sub job</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 46px;"><td style="width: 154px; height: 46px;">pulse\_short\_time\_ms</td><td style="width: 69px; height: 46px;">integer</td><td style="width: 251px; height: 46px;">Time interval for short output pulse to stay active </td><td style="width: 79px; height: 46px;">No</td><td style="width: 109px; height: 46px;">0</td><td style="width: 69px; height: 46px;">  
</td><td style="width: 69px; height: 46px;">  
</td></tr><tr style="height: 46px;"><td style="width: 154px; height: 46px;">pulse\_long\_time\_ms</td><td style="width: 69px; height: 46px;">integer</td><td style="width: 251px; height: 46px;">Time interval for long output pulse to stay active</td><td style="width: 79px; height: 46px;">No</td><td style="width: 109px; height: 46px;">0</td><td style="width: 69px; height: 46px;">  
</td><td style="width: 69px; height: 46px;">  
</td></tr></tbody></table>

# 17 Metering protocols

- DLMS/COSEM
- IEC 62056-21
- MBus Serial/TCP
- Elgama (Meters based on IEC 62056-21 / 31 protocols)

# 17.1 DLMS/COSEM

### Introduction

**IEC 62056** is a set of standards for electricity metering data exchange by [International Electrotechnical Commission](https://en.wikipedia.org/wiki/International_Electrotechnical_Commission "International Electrotechnical Commission").

The IEC 62056 standards are the [international standard](https://en.wikipedia.org/wiki/International_standard "International standard") versions of the DLMS/COSEM specification.

**DLMS** or **Device Language Message Specification** (originally Distribution Line Message Specification),<sup class="reference" id="bkmrk-%5B1%5D">[\[1\]](https://en.wikipedia.org/wiki/IEC_62056#cite_note-1)</sup> is the suite of standards developed and maintained by the DLMS User Association (DLMS UA) and has been adopted by the IEC TC13 WG14 into the IEC 62056 series of standards. The DLMS User Association maintains a D Type liaison with IEC TC13 WG14 responsible for international standards for meter data exchange and establishing the IEC 62056 series. In this role, the DLMS UA provides maintenance, registration and compliance certification services for IEC 62056 DLMS/COSEM.

**COSEM** or **Companion Specification for Energy Metering**, includes a set of specifications that defines the [transport](https://en.wikipedia.org/wiki/Transport_layer "Transport layer") and [application](https://en.wikipedia.org/wiki/Application_layer "Application layer") layers of the DLMS protocol. The DLMS User Association defines the protocols into a set of four specification documents namely Green Book, Yellow Book, Blue Book and White Book. The Blue Book describes the COSEM meter object model and the OBIS object identification system, the Green Book describes the architecture and protocols, the Yellow Book treats all the questions concerning conformance testing, the White Book contains the glossary of terms. If a product passes the [conformance test](https://en.wikipedia.org/wiki/Conformance_test "Conformance test") specified in the Yellow Book, then a certification of DLMS/COSEM compliance is issued by the DLMS UA.

The IEC TC13 WG14 groups the DLMS specifications under the common heading: "Electricity metering data exchange - The DLMS/COSEM suite". DLMS/COSEM protocol is not specific to electricity metering, it is also used for gas, water and heat metering.

Source: [https://en.wikipedia.org/wiki/IEC\_62056](https://en.wikipedia.org/wiki/IEC_62056 "Wikipedia")

### DLMS Master

#### Overview

DLMS (Device Language Message Specification) is a suite of standards developed and maintained by the DLMS User Association. COSEM (Companion Specification for Energy Metering) includes a set of specifications that define the transport and application layers of the DLMS protocol.

In DLMS/COSEM all the data in electronic utility meters and devices are represented by means of mapping them to appropriate classes and related attribute values.

Objects are identified with the help of OBIS (Object Identification System) codes (as per IEC 62056-61).

The DLMS driver allows only for readout and displaying only numeric values of DLMS object data fields. Connection via TCP (HDLC or WRAPPER) or serial (RS232/RS485) port are supported.

The setup of the DLMS driver consists of communication and tag configuration. Protocol specific parameters (except for DLMS/IEC handshake mode) apply for both serial and IP connections.

#### Configuration

##### Devices section

**serial\_number**, **physical\_address** and **logical\_address** define the meter addressing parameters. Either **serial\_number** (meter serial number) or a combination of **physical\_address** and **logical\_address** is used. If a serial number is provided, physical and logical server addresses are ignored.

<p class="callout warning">Before configuring the Device section it is best to first check the connection parameters with a 3rd party DLMS utility.</p>

**client\_address** is defined in hex and usually depends on the authentication used. Most meters support hex 11 for no authentication.

**type** defines the object referencing. SN should be used for short name referencing and LN for logical name referencing.

**mode** defines the communications mode. If IEC is used along with comms settings for serial readout, the connection is initiated as per IEC 62056-21, at the default initial baud rate (300 7E1). DLMS-HDLC shall be used for HDLC connections via IP. DLMS-WRAPPER is also supported for IP connections. The default setting is DLMS-HDLC.

**timeout\_ms** defines the reply timeout for telegrams both via serial and TCP.

**auth** and **password** define the authentication mode and password. This can be set to None, or other authentication variant (see table below), depending on the mode configured and supported by the particular meter.  
**ip** and **port** define the IP address and TCP port for DLMS communication via IP.

<p class="callout warning">Connection parameters are device specific and can differ between makes, models and utility companies. For initial connection settings please refer to the configuration of the particular meter.</p>

<p class="callout info">When ip and port are configured, any serial port settings are ignored and connection is initiated only via IP.</p>

Device configuration parameters for DLMS meters acquisition:

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 1584.12px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 15.2002%; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 8.40202%; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 29.6603%; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 15.3238%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 9.51557%; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 21.997%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 7.66189%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 7.66189%; height: 30.0938px;">RTU</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Min</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Max</th></tr><tr style="height: 35px;"><td style="width: 15.2002%; height: 35px;">name

</td><td style="width: 8.40202%; height: 35px;">string</td><td style="width: 29.6603%; height: 35px;">User-­friendly name for a device

</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 9.51557%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 15.2002%; height: 35px;">description</td><td style="width: 8.40202%; height: 35px;">string</td><td style="width: 29.6603%; height: 35px;">Description of a device

</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 15.2002%; height: 35px;">device\_alias</td><td style="width: 8.40202%; height: 35px;">string</td><td style="width: 29.6603%; height: 35px;">Alphanumeric string to identify a device

</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 9.51557%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 57px;"><td style="width: 15.2002%; height: 57px;">enable</td><td style="width: 8.40202%; height: 57px;">boolean</td><td style="width: 29.6603%; height: 57px;">Enabling/disabling of a device

</td><td style="width: 7.66189%; height: 57px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 57px;">1</td><td style="width: 10.9985%; height: 57px;">0</td><td style="width: 10.9985%; height: 57px;">1</td></tr><tr style="height: 49px;"><td style="width: 15.2002%; height: 49px;">protocol</td><td style="width: 8.40202%; height: 49px;">string</td><td style="width: 29.6603%; height: 49px;">Protocol to be used

</td><td style="width: 7.66189%; height: 49px;">Yes</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 9.51557%; height: 49px;">  
</td><td class="align-center" colspan="2" style="width: 21.997%; height: 49px;">DLMS</td></tr><tr style="height: 29px;"><td style="width: 15.2002%; height: 29px;">serial\_number</td><td style="width: 8.40202%; height: 29px;">integer</td><td style="width: 29.6603%; height: 29px;">Meter serial number

</td><td style="width: 7.66189%; height: 29px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 29px;">0</td><td style="width: 10.9985%; height: 29px;">  
</td><td style="width: 10.9985%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 15.2002%; height: 17px;">physical\_address</td><td style="width: 8.40202%; height: 17px;">integer</td><td style="width: 29.6603%; height: 17px;">Meter physical server address

</td><td style="width: 7.66189%; height: 17px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 17px;">1600</td><td style="width: 10.9985%; height: 17px;">  
</td><td style="width: 10.9985%; height: 17px;">  
</td></tr><tr style="height: 29px;"><td style="width: 15.2002%; height: 20px;">logical\_address</td><td style="width: 8.40202%; height: 20px;">integer</td><td style="width: 29.6603%; height: 20px;">Meter logical server address

</td><td style="width: 7.66189%; height: 20px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 20px;">0</td><td style="width: 10.9985%; height: 20px;">  
</td><td style="width: 10.9985%; height: 20px;">  
</td></tr><tr style="height: 49px;"><td style="width: 15.2002%; height: 21px;">address\_size</td><td style="width: 8.40202%; height: 21px;">integer</td><td style="width: 29.6603%; height: 21px;">Meter address size in bytes

</td><td style="width: 7.66189%; height: 21px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 21px;">1</td><td style="width: 10.9985%; height: 21px;">1</td><td style="width: 10.9985%; height: 21px;">4</td></tr><tr style="height: 29px;"><td style="width: 15.2002%; height: 10px;">client\_address

</td><td style="width: 8.40202%; height: 10px;">integer</td><td style="width: 29.6603%; height: 10px;">Client address

</td><td style="width: 7.66189%; height: 10px;">Yes</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 9.51557%; height: 10px;">  
</td><td style="width: 10.9985%; height: 10px;">  
</td><td style="width: 10.9985%; height: 10px;">  
</td></tr><tr style="height: 29px;"><td style="width: 15.2002%; height: 29px;">type</td><td style="width: 8.40202%; height: 29px;">string</td><td style="width: 29.6603%; height: 29px;">Meter object referencing: SN - short referencing, LN - logical referencing

</td><td style="width: 7.66189%; height: 29px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 29px;">SN</td><td colspan="2" style="width: 21.997%; height: 29px;">SN, LN</td></tr><tr style="height: 29px;"><td style="width: 15.2002%; height: 24px;">mode</td><td style="width: 8.40202%; height: 24px;">string</td><td style="width: 29.6603%; height: 24px;">Initial handshake mode.

</td><td style="width: 7.66189%; height: 24px;">Yes</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 9.51557%; height: 24px;">DLMS-­HDLC</td><td colspan="2" style="width: 21.997%; height: 24px;">IEC, DLMS, DLMS-HDLC or DLMS­-WRAPPER</td></tr><tr style="height: 29px;"><td style="width: 15.2002%; height: 10px;">timeout\_ms</td><td style="width: 8.40202%; height: 10px;">integer</td><td style="width: 29.6603%; height: 10px;">Timeout in milliseconds

</td><td style="width: 7.66189%; height: 10px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 10px;">2500</td><td style="width: 10.9985%; height: 10px;">  
</td><td style="width: 10.9985%; height: 10px;">  
</td></tr><tr style="height: 123px;"><td style="width: 15.2002%; height: 76px;">auth</td><td style="width: 8.40202%; height: 76px;">string</td><td style="width: 29.6603%; height: 76px;">Authentication.

</td><td style="width: 7.66189%; height: 76px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 76px;">None</td><td colspan="2" style="width: 21.997%; height: 76px;">None, Low, High, HighMd5, HighSha1, HighSha256, HighGmac, HighEcdsa</td></tr><tr style="height: 57px;"><td style="width: 15.2002%; height: 57px;">password</td><td style="width: 8.40202%; height: 57px;">string</td><td style="width: 29.6603%; height: 57px;">Password for authentication

</td><td style="width: 7.66189%; height: 57px;">No (when auth is None)</td><td style="width: 7.66189%; height: 35px;">No (when auth is None)</td><td style="width: 9.51557%; height: 57px;">  
</td><td style="width: 10.9985%; height: 57px;">  
</td><td style="width: 10.9985%; height: 57px;">  
</td></tr><tr style="height: 35px;"><td style="width: 15.2002%; height: 35px;">ip</td><td style="width: 8.40202%; height: 35px;">string</td><td style="width: 29.6603%; height: 35px;">IP address

</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 7.66189%; height: 35px;">-</td><td style="width: 9.51557%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 15.2002%; height: 29px;">port</td><td style="width: 8.40202%; height: 29px;">integer</td><td style="width: 29.6603%; height: 29px;">TCP port

</td><td style="width: 7.66189%; height: 29px;">Yes</td><td style="width: 7.66189%; height: 35px;">-</td><td style="width: 9.51557%; height: 29px;">  
</td><td style="width: 10.9985%; height: 29px;">  
</td><td style="width: 10.9985%; height: 29px;">  
</td></tr><tr style="height: 57px;"><td style="width: 15.2002%; height: 31px;">device</td><td style="width: 8.40202%; height: 31px;">  
</td><td style="width: 29.6603%; height: 31px;">Communication port

</td><td style="width: 7.66189%; height: 31px;">-</td><td style="width: 7.66189%; height: 35px;">Yes</td><td style="width: 9.51557%; height: 31px;">  
</td><td style="width: 10.9985%; height: 31px;">PORT1</td><td style="width: 10.9985%; height: 31px;">PORT2</td></tr><tr style="height: 80px;"><td style="width: 15.2002%; height: 63px;">baudrate</td><td style="width: 8.40202%; height: 63px;">integer</td><td style="width: 29.6603%; height: 63px;">Communication speed (bauds/s)

</td><td style="width: 7.66189%; height: 63px;">-</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 63px;">9600</td><td colspan="2" style="width: 21.997%; height: 63px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200</td></tr><tr style="height: 49px;"><td style="width: 15.2002%; height: 49px;">databits</td><td style="width: 8.40202%; height: 49px;">integer</td><td style="width: 29.6603%; height: 49px;">Data bit count for communication

</td><td style="width: 7.66189%; height: 49px;">-</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 49px;">8</td><td style="width: 10.9985%; height: 49px;">6</td><td style="width: 10.9985%; height: 49px;">9</td></tr><tr style="height: 49px;"><td style="width: 15.2002%; height: 49px;">stopbits</td><td style="width: 8.40202%; height: 49px;">integer</td><td style="width: 29.6603%; height: 49px;">Stop bit count for communication

</td><td style="width: 7.66189%; height: 49px;">-</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 49px;">1</td><td style="width: 10.9985%; height: 49px;">1</td><td style="width: 10.9985%; height: 49px;">2</td></tr><tr style="height: 60px;"><td style="width: 15.2002%; height: 60px;">parity</td><td style="width: 8.40202%; height: 60px;">string</td><td style="width: 29.6603%; height: 60px;">Communication parity option

</td><td style="width: 7.66189%; height: 60px;">-</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 60px;">none</td><td colspan="2" style="width: 21.997%; height: 60px;">none, even, odd</td></tr><tr style="height: 91px;"><td style="width: 15.2002%; height: 52px;">flowcontrol</td><td style="width: 8.40202%; height: 52px;">string</td><td style="width: 29.6603%; height: 52px;">Communication device flow control option.

</td><td style="width: 7.66189%; height: 52px;">-</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 52px;">none</td><td colspan="2" style="width: 21.997%; height: 52px;">none</td></tr><tr style="height: 35px;"><td style="width: 15.2002%; height: 35px;">retry\_counter</td><td style="width: 8.40202%; height: 35px;">integer</td><td style="width: 29.6603%; height: 35px;">Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued

</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 35px;">3</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 15.2002%; height: 35px;">scan\_rate\_ms</td><td style="width: 8.40202%; height: 35px;">integer</td><td style="width: 29.6603%; height: 35px;">If provided and positive all reads and writes will be executed within the timeframe in milliseconds

</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%; height: 35px;">10000</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr><tr><td style="width: 15.2002%;">reconnect\_time</td><td style="width: 8.40202%;">integer</td><td style="width: 29.6603%;">Defines how often (in milliseconds) the client will try to reestablish communication with the meter after an unsuccessful attempt.

</td><td style="width: 7.66189%;">No</td><td style="width: 7.66189%; height: 35px;">No</td><td style="width: 9.51557%;">1000</td><td style="width: 10.9985%;">  
</td><td style="width: 10.9985%;">  
</td></tr></tbody></table>

##### Signals section

DLMS configuration parameters creating signals:

<table border="1" id="bkmrk-parameter-type-descr-0" style="border-collapse: collapse; width: 100%; height: 584.12px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 12.4815%; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 9.76273%; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 31.0183%; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 12.8522%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 11.8636%; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 21.997%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 6.4261%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 6.4261%; height: 30.0938px;">RTU</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Min</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Max</th></tr><tr style="height: 35px;"><td style="width: 12.4815%; height: 35px;">signal\_name</td><td style="width: 9.76273%; height: 35px;">string

</td><td style="width: 31.0183%; height: 35px;">User-­friendly signal name

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;"></td><td style="width: 10.9985%; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 12.4815%; height: 35px;">device\_alias</td><td style="width: 9.76273%; height: 35px;">string

</td><td style="width: 31.0183%; height: 35px;">Device alias from a Devices tab

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;"></td><td style="width: 10.9985%; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 12.4815%; height: 35px;">signal\_alias</td><td style="width: 9.76273%; height: 35px;">string

</td><td style="width: 31.0183%; height: 35px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;"></td><td style="width: 10.9985%; height: 35px;"></td></tr><tr style="height: 35px;"><td style="width: 12.4815%; height: 35px;">enable</td><td style="width: 9.76273%; height: 35px;">boolean

</td><td style="width: 31.0183%; height: 35px;">Enabling/disabling of an individual signal

</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 11.8636%; height: 35px;">1</td><td style="width: 10.9985%; height: 35px;">0

</td><td style="width: 10.9985%; height: 35px;">1

</td></tr><tr style="height: 35px;"><td style="width: 12.4815%; height: 35px;">log</td><td style="width: 9.76273%; height: 35px;">boolean

</td><td style="width: 31.0183%; height: 35px;">Enable logging in event log

</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 11.8636%; height: 35px;">0</td><td style="width: 10.9985%; height: 35px;">0

</td><td style="width: 10.9985%; height: 35px;">1

</td></tr><tr style="height: 36px;"><td style="width: 12.4815%; height: 36px;">short\_name</td><td style="width: 9.76273%; height: 36px;">integer

</td><td style="width: 31.0183%; height: 36px;">Address of value to read (Short name).

</td><td style="width: 6.4261%; height: 36px;">No</td><td style="width: 6.4261%; height: 35px;">No</td><td style="width: 11.8636%; height: 36px;">0</td><td style="width: 10.9985%; height: 36px;"></td><td style="width: 10.9985%; height: 36px;"></td></tr><tr style="height: 35px;"><td style="width: 12.4815%; height: 35px;">obis\_job</td><td style="width: 9.76273%; height: 35px;">string

</td><td style="width: 31.0183%; height: 35px;">OBIS codes can be accompanied by an attribute index, eg.: 1.0.1.8.0.255:2. Objects of register and extended register types do not require indexes and the scalers are applied to values automatically (though they can still be used if attributes other than the value need to be read out).

</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 6.4261%; height: 35px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;"></td><td style="width: 10.9985%; height: 35px;"></td></tr></tbody></table>

#### Debugging the DLMS service

If the configuration for DLMS devices is set up, the handler for the protocol will start automatically. If the configuration is missing or contains errors, the protocol will not start. It is done intentionally to decrease unnecessary memory usage.

If DLMS does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from the command-line interface and find out why the link is not functioning properly. To launch a debugging session, a user should stop dlms process and run dlms command with respective flags as in the table shown below.

Procedure for DLMS protocol service debugging:

- **Step 1**: Service must be stopped by entering the following command into the WCC Lite:  
    **/etc/init.d/dlms stop**
- **Step 2**: After service is stopped it must be started with the preferred configuration file (JSON files found in /etc/dlms folder) and a debug level 7: **dlms ­-c /etc/dlms/dlms.json ­-d7 --dlms** Additional output forming options described in the table below.

- **Step 3**: Once the problem is diagnosed normal operations can be resumed with the following command: **/etc/init.d/dlms start**

DLMS command line debugging options

<table border="1" class="align-center" id="bkmrk-option%C2%A0-description-"><tbody><tr><td>Option </td><td>Description</td></tr><tr><td>­-h \[ –-help \] </td><td>Display help information</td></tr><tr><td>­-V \[ –-version \] </td><td>Show version</td></tr><tr><td>-p \[ -–port \]</td><td>­Show output for one port only</td></tr><tr><td>­-d &lt;debug level&gt;</td><td>Set debugging level</td></tr><tr><td>-­c \[ –-config \] </td><td>Config path</td></tr></tbody></table>

# 17.2 IEC 62056-21

### Introduction

**IEC 61107** or currently IEC 62056-21, was an international standard for a computer [protocol](https://en.wikipedia.org/wiki/Communications_protocol "Communications protocol") to read utility meters. It is designed to operate over any media, including the [Internet](https://en.wikipedia.org/wiki/Internet "Internet"). A meter sends [ASCII](https://en.wikipedia.org/wiki/ASCII "ASCII") (in modes A..D) or [HDLC](https://en.wikipedia.org/wiki/HDLC "HDLC") (mode E) data to a nearby hand-held unit (HHU) using a [serial port](https://en.wikipedia.org/wiki/Serial_port "Serial port"). The physical media are usually either modulated light, sent with an [LED](https://en.wikipedia.org/wiki/LED "LED") and received with a [photodiode](https://en.wikipedia.org/wiki/Photodiode "Photodiode"), or a pair of wires, usually modulated by a 20mA [current loop](https://en.wikipedia.org/wiki/Current_loop "Current loop"). The protocol is usually [half-duplex](https://en.wikipedia.org/wiki/Duplex_(telecommunications) "Duplex (telecommunications)").

The following exchange usually takes a second or two, and occurs when a person from the utility company presses a meter-reading gun against a transparent faceplate on the meter, or plugs into the metering bus at the mailbox of an apartment building.

The general protocol consists of a "sign on" sequence, in which a handheld unit identifies itself to the metering unit. During sign-on, the handheld unit addresses a particular meter by number. The meter and hand-held unit negotiate various parameters such as the maximum frame length during transmission and reception, whether multiple frames can be sent without acknowledging individual frames ([windowing](https://en.wikipedia.org/wiki/Flow_control_(data) "Flow control (data)")), the fastest communication rate that they can both manage (only in case of mode E switching to HDLC) etc.

Next, the meter informs the handheld unit about the various parameters that are available with it in various security settings viz. the 'no-security logical group', ' the low-security logical groups' and ' the high-security logical groups'.

If the parameter required is in the no-security group, just a get.request will provide the HHU with the desired response. If the parameter required is in the low-security group, a password authentication of the HHU is required before information can be read.

In case of high-security parameters, the meter challenges the handheld unit with a cryptographic password. The handheld unit must return an encrypted password. If the password exchange is correct, the meter accepts the handheld unit: it is "signed on."

After signing on, the handheld unit generally reads a meter description. This describes some registers that describe the current count of metered units (i.e. kilowatt hours, megajoules, liters of gas or water) and the metering unit's reliability (is it still operating correctly?). Occasionally a manufacturer will define a new quantity to measure, and in this case, a new or different data type will appear in the meter definition. Most metering units have special modes for calibration and resetting meter registers. These modes are usually protected by anti-tampering features such as switches that sense if the meter enclosure has been opened.

The HHU may also be given limited rights to set or reset certain parameters in the meter.

The handheld unit then sends a sign-off message. If no sign-off message is sent, the meter automatically signs off after a previously negotiated time interval after the last message.

Source: [https://en.wikipedia.org/wiki/IEC\_62056#IEC\_62056-21](https://en.wikipedia.org/wiki/IEC_62056#IEC_62056-21 "Wikipedia")

### Overview

The IEC 62056-21 standard defines protocol specifications for local meter data exchange.  
Data is read out via serial port in modes A, B or C. The default initial serial port settings are 300 bps 7E1, as per standard, but can be user configured.

The driver implementation additionally allows for communication via TCP/IP, which is not described in the standard. In this case, baud rate acknowledgement is allowed however actual switchover between baud rates is not possible.

**Mode A**: data is requested and read out at the configured baud rate.

**Mode B**: data is requested at the configured baud rate and mutually switched to the baud rate proposed by the meter. Baud rate confirmation is absent.

**Mode C**: data is requested at the configured baud rate, new baud rate is proposed by the meter and, if acknowledged, data is read out at the proposed baud rate.

Currently data readout is supported in modes A, B and C.

For data readout it is necessary to know the port settings and the format of OBIS code representation as they can slightly differ (see table) depending on the configuration of the meter.

### Configuration

#### Device section

The serialnumber defines the serial number of the meter. 0 (zero) will result in a ’/?!’ handshake string and may cause issues if more than one meter is wired to the serial port.

The baudrate defines the initial connection baud rate. In modes B and C this will be switched to what ever baud rate is proposed by the meter.

The meter\_model defines the meter profile. This is reserved for future use and should be set to 1. type defines the connection mode. Modes A, B and C are supported.

<p class="callout warning">If **ip** or **port** parameters are configured, any <span style="text-decoration: underline;">serial port settings are ignored</span> and connections are initiated via TCP.</p>

IEC 62056-21 device configuration parameters:

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 1584.12px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 15.5709%; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 9.51496%; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 28.1766%; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 12.8522%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 11.8636%; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 21.997%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 6.4261%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 6.4261%; height: 30.0938px;">RTU</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Min</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Max</th></tr><tr style="height: 35.2983px;"><td style="width: 15.5709%; height: 35.2983px;">name

</td><td style="width: 9.51496%; height: 35.2983px;">string</td><td style="width: 28.1766%; height: 35.2983px;">User-friendly name for a device

</td><td style="width: 6.4261%; height: 35.2983px;">Yes</td><td style="width: 6.4261%; height: 35.2983px;">Yes</td><td style="width: 11.8636%; height: 35.2983px;">  
</td><td style="width: 10.9985%; height: 35.2983px;">  
</td><td style="width: 10.9985%; height: 35.2983px;">  
</td></tr><tr style="height: 35.2983px;"><td style="width: 15.5709%; height: 35.2983px;">description

</td><td style="width: 9.51496%; height: 35.2983px;">string</td><td style="width: 28.1766%; height: 35.2983px;">Description of a device

</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 35.2983px;">  
</td><td style="width: 10.9985%; height: 35.2983px;">  
</td><td style="width: 10.9985%; height: 35.2983px;">  
</td></tr><tr style="height: 35.2983px;"><td style="width: 15.5709%; height: 35.2983px;">device\_alias

</td><td style="width: 9.51496%; height: 35.2983px;">string</td><td style="width: 28.1766%; height: 35.2983px;">Alphanumeric string to identify a device

</td><td style="width: 6.4261%; height: 35.2983px;">Yes</td><td style="width: 6.4261%; height: 35.2983px;">Yes</td><td style="width: 11.8636%; height: 35.2983px;">  
</td><td style="width: 10.9985%; height: 35.2983px;">  
</td><td style="width: 10.9985%; height: 35.2983px;">  
</td></tr><tr style="height: 35.2983px;"><td style="width: 15.5709%; height: 35.2983px;">enable</td><td style="width: 9.51496%; height: 35.2983px;">boolean</td><td style="width: 28.1766%; height: 35.2983px;">Enabling/disabling of a device

</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 35.2983px;">1</td><td style="width: 10.9985%; height: 35.2983px;">0</td><td style="width: 10.9985%; height: 35.2983px;">1</td></tr><tr style="height: 35.2983px;"><td style="width: 15.5709%; height: 35.2983px;">protocol</td><td style="width: 9.51496%; height: 35.2983px;">string</td><td style="width: 28.1766%; height: 35.2983px;">Protocol to be used

</td><td style="width: 6.4261%; height: 35.2983px;">Yes</td><td style="width: 6.4261%; height: 35.2983px;">Yes</td><td style="width: 11.8636%; height: 35.2983px;">  
</td><td colspan="2" style="width: 21.997%; height: 35.2983px;">IEC 62056-21

</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">poll\_delay\_ms</td><td style="width: 9.51496%; height: 46.5057px;">integer</td><td style="width: 28.1766%; height: 46.5057px;">Minimum time delay in milliseconds to wait before sending any data on port.</td><td style="width: 6.4261%; height: 46.5057px;">No</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 46.5057px;">200</td><td style="width: 10.9985%; height: 46.5057px;">  
</td><td style="width: 10.9985%; height: 46.5057px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 15.5709%; height: 29.7017px;">scan\_rate\_ms</td><td style="width: 9.51496%; height: 29.7017px;">integer</td><td style="width: 28.1766%; height: 35.2983px;">  
</td><td style="width: 6.4261%; height: 29.7017px;">No</td><td style="width: 6.4261%; height: 29.7017px;">No</td><td style="width: 11.8636%; height: 29.7017px;">10000</td><td style="width: 10.9985%; height: 29.7017px;">  
</td><td style="width: 10.9985%; height: 29.7017px;">  
</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">device</td><td style="width: 9.51496%; height: 46.5057px;">string</td><td style="width: 28.1766%; height: 46.5057px;">Communication port</td><td style="width: 6.4261%; height: 46.5057px;">-</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 46.5057px;">  
</td><td style="width: 10.9985%; height: 46.5057px;">PORT1</td><td style="width: 10.9985%; height: 46.5057px;">PORT2</td></tr><tr style="height: 82.8409px;"><td style="width: 15.5709%; height: 82.8409px;">baudrate</td><td style="width: 9.51496%; height: 82.8409px;">integer

</td><td style="width: 28.1766%; height: 82.8409px;">Communication speed (bauds/s)</td><td style="width: 6.4261%; height: 82.8409px;"> -</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 82.8409px;"><div><div>9600</div></div></td><td colspan="2" style="width: 21.997%; height: 82.8409px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">databits</td><td style="width: 9.51496%; height: 46.5057px;">integer</td><td style="width: 28.1766%; height: 46.5057px;">Data bit count for communication</td><td style="width: 6.4261%; height: 46.5057px;">-</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 46.5057px;">8</td><td style="width: 10.9985%; height: 46.5057px;">6</td><td style="width: 10.9985%; height: 46.5057px;">9</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">stopbits</td><td style="width: 9.51496%; height: 46.5057px;">integer</td><td style="width: 28.1766%; height: 46.5057px;">Stop bit count for communication</td><td style="width: 6.4261%; height: 46.5057px;">-</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 46.5057px;">1</td><td style="width: 10.9985%; height: 46.5057px;">1</td><td style="width: 10.9985%; height: 46.5057px;">2</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">parity</td><td style="width: 9.51496%; height: 46.5057px;">string</td><td style="width: 28.1766%; height: 46.5057px;">Communication parity option</td><td style="width: 6.4261%; height: 46.5057px;">-</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 46.5057px;">NONE</td><td colspan="2" style="width: 21.997%; height: 46.5057px;">NONE, EVEN, ODD</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">flowcontrol</td><td style="width: 9.51496%; height: 46.5057px;">string</td><td style="width: 28.1766%; height: 46.5057px;">Communication device flow control option</td><td style="width: 6.4261%; height: 46.5057px;">-</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 46.5057px;">  
</td><td colspan="2" style="width: 21.997%; height: 46.5057px;">NONE</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">serialnumber</td><td style="width: 9.51496%; height: 46.5057px;">unsigned long</td><td style="width: 28.1766%; height: 46.5057px;">Meter serial number</td><td style="width: 6.4261%; height: 46.5057px;">Yes</td><td style="width: 6.4261%; height: 35.2983px;">Yes</td><td style="width: 11.8636%; height: 46.5057px;">  
</td><td style="width: 10.9985%; height: 46.5057px;">1</td><td style="width: 10.9985%; height: 46.5057px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 15.5709%; height: 29.7017px;">serial\_close\_delay</td><td style="width: 9.51496%; height: 29.7017px;">integer</td><td style="width: 28.1766%; height: 29.7017px;">Delay before closing serial port</td><td style="width: 6.4261%; height: 29.7017px;">-</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 29.7017px;">400</td><td style="width: 10.9985%; height: 29.7017px;">  
</td><td style="width: 10.9985%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 15.5709%; height: 29.7017px;">timeout\_ms</td><td style="width: 9.51496%; height: 29.7017px;">integer</td><td style="width: 28.1766%; height: 29.7017px;">Timeout of waiting for incoming request</td><td style="width: 6.4261%; height: 29.7017px;">No</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 29.7017px;">2500</td><td style="width: 10.9985%; height: 29.7017px;">  
</td><td style="width: 10.9985%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 15.5709%; height: 29.7017px;">type</td><td style="width: 9.51496%; height: 29.7017px;">string</td><td style="width: 28.1766%; height: 29.7017px;">Defines a connection mode</td><td style="width: 6.4261%; height: 29.7017px;">No</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 29.7017px;">C</td><td colspan="2" style="width: 21.997%; height: 29.7017px;">A,B,C</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">t2</td><td style="width: 9.51496%; height: 46.5057px;">integer</td><td style="width: 28.1766%; height: 46.5057px;">Time to wait before acknowledging the suggested baud rate in mode C</td><td style="width: 6.4261%; height: 46.5057px;">No</td><td style="width: 6.4261%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 46.5057px;">300</td><td style="width: 10.9985%; height: 46.5057px;">200</td><td style="width: 10.9985%; height: 46.5057px;">1500</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">ip</td><td style="width: 9.51496%; height: 46.5057px;">string</td><td style="width: 28.1766%; height: 46.5057px;">IP address for TCP connection</td><td style="width: 6.4261%; height: 46.5057px;">Yes </td><td style="width: 6.4261%; height: 35.2983px;">-</td><td style="width: 11.8636%; height: 46.5057px;">  
</td><td style="width: 10.9985%; height: 46.5057px;">  
</td><td style="width: 10.9985%; height: 46.5057px;">  
</td></tr><tr style="height: 46.5057px;"><td style="width: 15.5709%; height: 46.5057px;">port</td><td style="width: 9.51496%; height: 46.5057px;">integer</td><td style="width: 28.1766%; height: 46.5057px;">TCP port</td><td style="width: 6.4261%; height: 46.5057px;">Yes </td><td style="width: 6.4261%; height: 35.2983px;">-</td><td style="width: 11.8636%; height: 46.5057px;">  
</td><td style="width: 10.9985%; height: 46.5057px;">0</td><td style="width: 10.9985%; height: 46.5057px;">65535</td></tr></tbody></table>

#### Signals section

**tag\_job\_todo** defines the job sub-job. This field should contain the exact representation of the OBIS code as it is configured in the meter. For E.g. if the parameter of interest is represented as

”1.8.0\*24(0147238.4\*kWh)”, the value of the configuration field should be ”1.8.0\*24” (excluding quotation marks).

IEC 62056-21 tags configuration parameters:

<table border="1" id="bkmrk-parameter-type-descr-0" style="border-collapse: collapse; width: 100%; height: 584.12px;"><tbody><tr style="height: 50.0781px;"><th rowspan="2" style="width: 12.4815%; height: 80.1719px;">**Parameter**  
  
</th><th rowspan="2" style="width: 9.76273%; height: 80.1719px;">**Type**  
  
</th><th rowspan="2" style="width: 32.9975%; height: 80.1719px;">**Description**  
  
</th><th class="align-center" colspan="2" style="width: 10.873%; height: 80.1719px;">**Required**  
  
</th><th rowspan="2" style="width: 11.8636%; height: 80.1719px;">**Default Value**

(when not specified)

</th><th class="align-center" colspan="2" style="width: 21.997%; height: 50.0781px;">**Range**  
  
</th></tr><tr style="height: 30.0938px;"><th class="align-center" style="width: 6.42415%; height: 30.0938px;">TCP</th><th class="align-center" style="width: 4.44884%; height: 30.0938px;">RTU</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Min</th><th class="align-center" style="width: 10.9985%; height: 30.0938px;">Max</th></tr><tr style="height: 35px;"><td style="width: 12.4815%; height: 35px;">signal\_name</td><td style="width: 9.76273%; height: 35px;">string</td><td style="width: 32.9975%; height: 35px;">User­-friendly signal name</td><td style="width: 6.42415%; height: 35px;">Yes</td><td style="width: 4.44884%; height: 35.2983px;">Yes</td><td style="width: 11.8636%; height: 35px;"></td><td colspan="2" style="width: 21.997%; height: 35px;">  
</td></tr><tr style="height: 29px;"><td style="width: 12.4815%; height: 29px;">device\_alias</td><td style="width: 9.76273%; height: 29px;">string</td><td style="width: 32.9975%; height: 29px;">Device alias from a Devices tab</td><td style="width: 6.42415%; height: 29px;">Yes</td><td style="width: 4.44884%; height: 35.2983px;">Yes</td><td style="width: 11.8636%; height: 29px;">  
</td><td style="width: 10.9985%; height: 29px;">  
</td><td style="width: 10.9985%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 12.4815%; height: 29px;">signal\_alias</td><td style="width: 9.76273%; height: 29px;">string

</td><td style="width: 32.9975%; height: 29px;">Unique alphanumeric name of the signal to be use</td><td style="width: 6.42415%; height: 29px;">Yes</td><td style="width: 4.44884%; height: 35.2983px;">Yes</td><td style="width: 11.8636%; height: 29px;">  
</td><td style="width: 10.9985%; height: 29px;">  
</td><td style="width: 10.9985%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 12.4815%; height: 29px;">enable</td><td style="width: 9.76273%; height: 29px;">boolean</td><td style="width: 32.9975%; height: 29px;">  
</td><td style="width: 6.42415%; height: 29px;">No</td><td style="width: 4.44884%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 29px;">1</td><td style="width: 10.9985%; height: 29px;">0</td><td style="width: 10.9985%; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 12.4815%; height: 29px;">log</td><td style="width: 9.76273%; height: 29px;">integer</td><td style="width: 32.9975%; height: 29px;">Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged</td><td style="width: 6.42415%; height: 29px;">No</td><td style="width: 4.44884%; height: 35.2983px;">No</td><td style="width: 11.8636%; height: 29px;">0</td><td style="width: 10.9985%; height: 29px;">0</td><td style="width: 10.9985%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 12.4815%;">number\_type</td><td style="width: 9.76273%;">string</td><td style="width: 32.9975%;">Number format type</td><td style="width: 6.42415%;">Yes</td><td style="width: 4.44884%; height: 35.2983px;">Yes</td><td style="width: 11.8636%;">  
</td><td style="width: 10.9985%;">  
</td><td style="width: 10.9985%;">  
</td></tr><tr style="height: 29px;"><td style="width: 12.4815%; height: 35px;">tag\_job\_todo

</td><td style="width: 9.76273%; height: 35px;">string</td><td style="width: 32.9975%; height: 35px;">Tag job in OBIS format

</td><td style="width: 6.42415%; height: 35px;">Yes</td><td style="width: 4.44884%; height: 35.2983px;">Yes</td><td style="width: 11.8636%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td><td style="width: 10.9985%; height: 35px;">  
</td></tr></tbody></table>

<p class="callout info">For **tag\_job\_todo** configuration it is best to first manually read the meter via PC or HHU (hand-held unit) to determine the exact OBIS representation format of the parameter as they can differ between meter manufacturers and utility companies.</p>

# 17.3 Elgama

### Overview

Elgama protocol is used for communications with *Elgama elektronika* electricity meters.

### Configuration

Available meter types (use number only):

- 0 ­ EPQM/LZQM
- 1 ­ EPQS
- 2 ­ GAMA300
- 3 ­ GAMA100
- 4 ­ ITS cl

##### Elgama parameters for *Device* tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 49px;"><td style="width: 107px; height: 35px;">name</td><td style="width: 73px; height: 35px;">string </td><td style="width: 289px; height: 35px;">User-friendly device name</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 80px; height: 35px;"></td><td style="width: 87px; height: 35px;">  
</td><td style="width: 87px; height: 35px;"></td></tr><tr style="height: 49px;"><td style="width: 107px; height: 33px;">description</td><td style="width: 73px; height: 33px;">string</td><td style="width: 289px; height: 33px;">Description of a device</td><td style="width: 79px; height: 33px;">No</td><td style="width: 80px; height: 33px;"></td><td style="width: 87px; height: 33px;">  
</td><td style="width: 87px; height: 33px;"></td></tr><tr style="height: 46px;"><td style="width: 107px; height: 29px;">device\_alias</td><td style="width: 73px; height: 29px;">string</td><td style="width: 289px; height: 29px;">Alphanumeric string to identify a device</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 80px; height: 29px;">  
</td><td style="width: 87px; height: 29px;">  
</td><td style="width: 87px; height: 29px;">  
</td></tr><tr style="height: 46px;"><td style="width: 107px; height: 19px;">enable</td><td style="width: 73px; height: 19px;">boolean</td><td style="width: 289px; height: 19px;">Enabling/disabling of a device</td><td style="width: 79px; height: 19px;">No</td><td style="width: 80px; height: 19px;">1</td><td style="width: 87px; height: 19px;">0</td><td style="width: 87px; height: 19px;">1</td></tr><tr style="height: 57px;"><td style="width: 107px; height: 23px;">protocol</td><td style="width: 73px; height: 23px;">string</td><td style="width: 289px; height: 23px;">Protocol to be used.</td><td style="width: 79px; height: 23px;">Yes</td><td style="width: 80px; height: 23px;">  
</td><td colspan="2" style="width: 174px; height: 23px;">Elgama

</td></tr><tr style="height: 46px;"><td style="width: 107px; height: 14px;">device</td><td style="width: 73px; height: 14px;">string</td><td style="width: 289px; height: 14px;">Communication port</td><td style="width: 79px; height: 14px;">Yes</td><td style="width: 80px; height: 14px;">  
</td><td style="width: 87px; height: 14px;">PORT1</td><td style="width: 87px; height: 14px;">PORT2</td></tr><tr style="height: 63px;"><td style="width: 107px; height: 28px;">baudrate</td><td style="width: 73px; height: 28px;">integer</td><td style="width: 289px; height: 28px;">Communication speed (bauds/s)</td><td style="width: 79px; height: 28px;">No</td><td style="width: 80px; height: 28px;">9600</td><td colspan="2" style="height: 28px; width: 174px;">300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200</td></tr><tr style="height: 27px;"><td style="width: 107px; height: 10px;">serial\_close\_delay</td><td style="width: 73px; height: 10px;">integer</td><td style="width: 289px; height: 10px;">Delay before closing serial port in milliseconds</td><td style="width: 79px; height: 10px;">No</td><td style="width: 80px; height: 10px;">400</td><td style="height: 10px; width: 87px;">  
</td><td style="width: 87px; height: 10px;">  
</td></tr><tr style="height: 46px;"><td style="width: 107px; height: 17px;">timeout\_ms</td><td style="width: 73px; height: 17px;">integer</td><td style="width: 289px; height: 17px;">Timeout of waiting for incoming request in milliseconds</td><td style="width: 79px; height: 17px;">Yes</td><td style="width: 80px; height: 17px;">  
</td><td style="height: 17px; width: 87px;">  
</td><td style="width: 87px; height: 17px;">  
</td></tr><tr style="height: 27px;"><td style="width: 107px; height: 27px;">id</td><td style="width: 73px; height: 27px;">integer</td><td style="width: 289px; height: 27px;">Meter serial number</td><td style="width: 79px; height: 27px;">Yes</td><td style="width: 80px; height: 27px;">  
</td><td style="height: 27px; width: 87px;">  
</td><td style="width: 87px; height: 27px;">  
</td></tr><tr style="height: 29px;"><td style="width: 107px; height: 29px;">meter\_model</td><td style="width: 73px; height: 29px;">integer</td><td style="width: 289px; height: 29px;">Meter type </td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 80px; height: 29px;">  
</td><td style="height: 29px; width: 87px;">0</td><td style="width: 87px; height: 29px;">4</td></tr><tr style="height: 29px;"><td style="width: 107px; height: 29px;">use\_time</td><td style="width: 73px; height: 29px;">boolean</td><td style="width: 289px; height: 29px;">Use system/meter (0/1) time (Default: 0)</td><td style="width: 79px; height: 29px;">No</td><td style="width: 80px; height: 29px;">0</td><td style="height: 29px; width: 87px;">0</td><td style="width: 87px; height: 29px;">1</td></tr></tbody></table>

##### Elgama parameters for the *Signals* tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 16px;"><td style="width: 106px; height: 10px;">signal\_name</td><td style="width: 75px; height: 10px;">string

</td><td style="width: 288px; height: 10px;">User-­friendly signal name

</td><td style="width: 78px; height: 10px;">Yes</td><td style="width: 82px; height: 10px;">  
</td><td style="width: 89px; height: 10px;"></td><td style="width: 89px; height: 10px;"></td></tr><tr style="height: 22px;"><td style="width: 106px; height: 17px;">device\_alias</td><td style="width: 75px; height: 17px;">string

</td><td style="width: 288px; height: 17px;">Device alias from a Devices tab

</td><td style="width: 78px; height: 17px;">Yes</td><td style="width: 82px; height: 17px;">  
</td><td style="width: 89px; height: 17px;"></td><td style="width: 89px; height: 17px;"></td></tr><tr style="height: 23px;"><td style="width: 106px; height: 10px;">signal\_alias</td><td style="width: 75px; height: 10px;">string

</td><td style="width: 288px; height: 10px;">Unique alphanumeric name of the signal to be used

</td><td style="width: 78px; height: 10px;">Yes</td><td style="width: 82px; height: 10px;">  
</td><td style="width: 89px; height: 10px;"></td><td style="width: 89px; height: 10px;"></td></tr><tr style="height: 29px;"><td style="width: 106px; height: 21px;">enable</td><td style="width: 75px; height: 21px;">boolean

</td><td style="width: 288px; height: 21px;">Enabling/disabling of an individual signal

</td><td style="width: 78px; height: 21px;">No</td><td style="width: 82px; height: 21px;">1</td><td style="width: 89px; height: 21px;">0

</td><td style="width: 89px; height: 21px;">1

</td></tr><tr style="height: 35px;"><td style="width: 106px; height: 35px;">log</td><td style="width: 75px; height: 35px;">integer

</td><td style="width: 288px; height: 35px;">Enable logging in event log

</td><td style="width: 78px; height: 35px;">No</td><td style="width: 82px; height: 35px;">0</td><td style="width: 89px; height: 35px;"></td><td style="width: 89px; height: 35px;"></td></tr><tr style="height: 29px;"><td style="width: 106px; height: 29px;">number\_type</td><td style="width: 75px; height: 29px;">string</td><td style="width: 288px; height: 29px;">Type of number (FLOAT, DOUBLE, DIGITAL, etc.)</td><td style="width: 78px; height: 29px;">Yes</td><td style="width: 82px; height: 29px;">  
</td><td style="width: 89px; height: 29px;">  
</td><td style="width: 89px; height: 29px;">  
</td></tr><tr style="height: 57px;"><td style="width: 106px; height: 57px;">job\_todo</td><td style="width: 75px; height: 57px;">string

</td><td style="width: 288px; height: 57px;">Elgama protocol specific data set values (see files below)</td><td style="width: 78px; height: 57px;">Yes</td><td style="width: 82px; height: 57px;">  
</td><td style="width: 89px; height: 57px;"></td><td style="width: 89px; height: 57px;"></td></tr><tr style="height: 29px;"><td style="width: 106px; height: 29px;">tag\_job\_todo</td><td style="width: 75px; height: 29px;">string</td><td style="width: 288px; height: 29px;">Tag sub job</td><td style="width: 78px; height: 29px;">Yes</td><td style="width: 82px; height: 29px;">  
</td><td style="width: 89px; height: 29px;">  
</td><td style="width: 89px; height: 29px;">  
</td></tr></tbody></table>

## Files

1. Example configuration file for Elgama protocol data mapping [download](https://wiki.elseta.com/attachments/544)

# 18 Excel Configuration

Protocol HUB uses the configuration in excel file format. Each sheet represents a specific part of the configuration:

Devices contain device lists and protocol-related configurations.
Signals contain a list of signals and their options.

First-line on each sheet is a header row that contains the parameter name for each column. Header order determines parameter names for each following row. Every line after the header is a new entry. An empty row is interpreted as the end of the sheet. Any rows after empty row are discarded.

# 18.1 Devices sheet

Devices sheet contains all devices to be configured on the gateway. Each row represents one device and its settings. Following options are required for each device:

- <span style="text-decoration: underline;">**name**</span> - Name of the device. Used for representation only.
- <span style="text-decoration: underline;">**description**</span> - A short description of the device. Used for representation only.
- <span style="text-decoration: underline;">**device\_alias**</span> - A unique short name for the device. It is used for linking signals to a device.

<p class="callout warning">An alias can only contain alphanumeric characters and dashes ( - and \_ ). The alias must be unique for each device.</p>

- <span style="text-decoration: underline;">**protocol**</span> - Protocol type to use on the device. The exact values of protocols are written in every protocol documentation. Please look into the range of supported protocols:

**IEC 61850 MMS:**

 – IEC 61850 Client (since FW 1.5.0)

 – IEC 61850 Server (since FW 1.5.0)

**IEC 60870-5:**

 – IEC 60870-5-101 master

 – IEC 60870-5-101 slave

 – IEC 60870-5-103 master

 – IEC 60870-5-104 master

\- IEC 60870-5-104 slave

**DNP 3.0 Serial/LAN/WAN:**

\- DNP3 Master

 – DNP3 Slave

**Modbus Serial/TCP:**

\- Modbus RTU/ASCII

 – Modbus TCP

**Metering protocols:**

\- DLMS/COSEM (since FW 1.3.0)

 – IEC 62056-21 (since FW 1.2.13)

 – MBus Serial

 – MBus TCP

 – Elgama (Meters based on IEC 62056-21 / 31 protocols)

**Industrial IOT protocols:**

\- MQTT

\- RESTful API

**Specific protocols:**

– Aurora (ABB PV inverters protocol)

– PowerOne (ABB PV inverters protocol)

– SMA Net (SMA PV inverters protocol)

– Kaco (Kaco PV inverters protocol)

– Ginlong (Ginlong PV inverters protocol)

– Solplus (Solutronic AG PV inverters protocol)

– ComLynx (Danfoss PV inverters protocol)

– Delta (Delta PV inverters protocol)

– Windlog (Wind sensors from RainWise Inc.)

– Vestas ( Wind turbines protocol)

– Internal data

– VBus.

<p class="callout info">Although device name rules aren’t strictly enforced, it is highly advised to give a unique name to every new device. Identical device names might introduce confusion while searching for signals in the Imported Signals tab.</p>

#### Optional settings

- **<span style="text-decoration: underline;">enable</span>** - Flag to enable or disable a device on the system. Can contain values 0 or 1.
- **<span style="text-decoration: underline;">event\_history\_size</span>** - Maximum number of signal events to save on device for later review. Older records will be erased. This feature is only available on cloud firmware.

#### Serial port settings

Required for any protocol that uses serial line communication.

- **<span style="text-decoration: underline;">device</span>** - Serial port for communication **(PORT1/PORT2)**
- **<span style="text-decoration: underline;">baudrate</span>** - Serial port speed. Valid values: **300**; **600**; **1200**; **2400**; **4800**; **9600**; **19200**; **38400**; **57600**; **115200**
- **<span style="text-decoration: underline;">databits</span>** - Number of data bits (6-9)
- **<span style="text-decoration: underline;">stopbits</span>** - Number of stop bits (1-2)
- **<span style="text-decoration: underline;">parity</span>** - Parity mode (none/even/odd)
- **<span style="text-decoration: underline;">flowcontrol</span>** - Flow control method (none/hardware/software)

#### TCP/IP settings

Settings for any protocol that uses communication over TCP/IP. Note that all TLS certificates and keys are stored in a single folder therefore only the name and not the path should be filled in respective fields.

<p class="callout info">TLS fields are only supported for IEC 61850 Client and Server, IEC-60870-5-104 Slave, and DNP3 Master and Slave, MQTT.</p>

- **<span style="text-decoration: underline;">ip</span>** - IP address for a master protocol to connect to;
- **<span style="text-decoration: underline;">bind\_address</span>** - one of the local IP addresses to bind the server to. Connections through other network devices will be ignored;
- **<span style="text-decoration: underline;">host</span>** - space-separated host IP addresses of master devices;
- **<span style="text-decoration: underline;">port</span>** - TCP port to listen for incoming connections;
- **<span style="text-decoration: underline;">tls\_local\_certificate</span>** - the name of local TLS certificate;
- **<span style="text-decoration: underline;">tls\_peer\_certificate</span>** - the name of a certificate authority (CA) TLS certificate;
- **<span style="text-decoration: underline;">tls\_private\_key</span>** - the name of a private key for making TLS connections.

# 18.2 Optional parameters for signals

The signals sheet contains all signals linked to devices. Each signal is defined in a single row. The Signal list can be split into multiple sheets. Each sheet name may start as Signals.

### Required attributes

These attributes are mandatory for every configured signal. Every Excel configuration should have specified them in the first row of the Signals sheet:

<div id="bkmrk-signal_name---name-o"><div>- **signal\_name** - Name of the signal. Used for representation only.
- **device\_alias** - Alias of a device defined in the Devices sheet. A signal is linked to a matching device.
- **signal\_alias** - A unique short name for the signal. It is used for linking signals to other signals. The alias can only contain alphanumeric characters and dashes ( - and \_ ). The device and signal alias combination must be unique.

</div></div>### Optional attributes

Optional attributes are required depending on the protocol in use and they can be used to extend protocol functionality:

<div id="bkmrk-source_device_alias-">- **source\_device\_alias** - Alias of a source device defined in the Devices sheet. If a user intends to use several signals and combine them via mathematical or logical function, every alias should be separated by a newline symbol (in the same cell). An operation used must also be defined in an operation column.
- **source\_signal\_alias** - Alias of a source signal defined in the Signals sheet. If a user intends to use several signals and combine them via mathematical or logical function, every alias should be separated by a [**separator** ](https://wiki.elseta.com/books/manual163/page/182-optional-parameters-for-signals#bkmrk-separators)symbol (in the same cell). An operation used must also be defined in an operation column. Each `source_signal_alias` should be posted in the same line as its respective `source_device_alias`. Aliases can only contain alphanumeric characters and dashes ( - and \_ ). The device and signal alias combination must be unique.
- **enable** - Flag to enable or disable signal on the system. Can contain values 0 or 1.
- **tag\_type** - Tag type. Simple signals are polled from the device. Virtual signals are computed
    
    internally.
- **units** - Signal value measurements units.
- **multiply** - Multiply the value by this number.
- **add** - Add this number to a value.
- **min\_value** - Minimum expected value. If the result is lower than this value, the overflow flag is raised.
- **max\_value** - Maximum expected value. If the result is higher than this value, the overflow flag is raised.
- **absolute\_threshold** - Absolute threshold level.
- **integral\_threshold** - Integral threshold level.
- **integral\_threshold\_interval\_ms** - Integral threshold addition interval in milliseconds.
- **threshold\_units** - Units used in threshold level fields (percent/real).
- **log** - Maximum number of records for this tag to keep in events log.
- **suppression\_values** - Space-separated numeric values to be used in suppression.
- **suppression\_time\_ms** - Suppression time in milliseconds.
- **operation** - Mathematical or logical operation to be used for signals defined in source\_signal\_alias column which are separated using **[separators](https://wiki.elseta.com/books/manual163/page/182-optional-parameters-for-signals#bkmrk-separators)**. Following mathematical operations for source signal values can be used: avg (average of all values), min (lowest value), max (highest value), median (median value), and sum (all values accumulated to a single number). An internal threshold is used to reduce value updates when the value doesn't change. Logical operations are intended for unsigned integers only.
- **bit\_select** - selecting an individual bit of an integer number; bit numeration starts from zero.
- **math\_expression** - a mathematical expression for master protocol monitor direction or slave command direction signals to be evaluated against. Explained in detail in **Mathematical expression document.**
- **source\_math\_expression** - a mathematical expression for master protocol command direction or slave monitor direction signals to be evaluated against. Explained in detail in **Mathematical expression document.**

</div><div id="bkmrk--0"></div><div id="bkmrk--1"></div><span style="text-decoration: underline;">Picture. Result of using an absolute threshold:</span>

[![image-1601977355078.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601977355078.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601977355078.png)

<span style="text-decoration: underline;">Picture. Result of using an integral threshold:</span>

![image-1601977339925.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601977339925.png)

### Signal recalculation operation priority

A value generated by some protocol usually has to be recalculated in one way or another. This might mean changing the value of an argument as well as adding flags needed for other protocols to correctly interpret results. As recalculation is a sequential process, some actions are done before others. The sequence of operations done to a value is as follows:

<div id="bkmrk-edition-of-attribute"><div><div><div>- *Edition of attributes*. Attributes for further interpretation are added. This might, for example, include a flag to show that a signal resembles an answer to a command;
- *Mathematical calculations*. **multiply**, **add**, **bit\_select,** and **math\_expression** columns are evaluated here;
- *Usage of last value*. The decision if last value for a signal should be used if a new value of a signal is not a number (NaN) or contains a non-topical (NT) flag;
- *Limiting of values*. If a value exceeds a lower or higher configured limit, the value is approximated not be lower (or higher) than the limit. An additional overflow (OV) flag is added as frequently used in IEC-60870-5 protocols;
- *Suppression of values*. As electrical circuits can be noisy, protocols may generate multiple values in a short amount of time. What is more, some values are considered as intermediaries and ideally should not be sent to SCADA unless they stay in the same state for some amount of time. **suppression\_values** and **suppression\_time\_ms** are used to configure this functionality;
- *Threshold* checking. If a new signal doesn’t cross a threshold target value, the value is suppressed and not used in further stages. **absolute\_threshold, integral\_threshold, integral\_threshold\_interval, threshold\_units** columns are used to configure this functionality.

</div></div></div></div><p class="callout info">Not all of the elements in this sequence have to be configured, missing operations are skipped and values are fed to a further stage of signal recalculation.</p>

### `number_type` field

This field is required for some protocols to determine a method to retrieve a signal value from hexadecimal form. Available values:

• **FLOAT** - 32-bit single precision floating point value according to IEEE 754 standard  
• **DOUBLE** - 64-bit double precision floating point value according to IEEE 754 standard   
• **DIGITAL** - 1-bit boolean value  
• **UNSIGNED8** - 8-bit unsigned integer (0 - 255)  
• **SIGNED8** - 8-bit signed integer (-128 - 127)  
• **UNSIGNED16** - 16-bit unsigned integer (0 - 65535)  
• **SIGNED16** - 16-bit signed integer (-32768 - 32767)  
• **UNSIGNED32** - 32-bit unsigned integer (0 - 4294967295)  
• **SIGNED32** - 32-bit signed integer (-2147483648 - 2147483647)  
• **UNSIGNED64** - 64-bit unsigned integer (0 - 18446744073709551615)  
• **SIGNED64** - 64-bit signed integer (-9223372036854775808 - 9223372036854775807)

Number conversion uses **big-endian** byte order by default. Converted data will be invalid if the byte order on the connected device side is different. In such a case, byte swap operations can be used. Adding swap prefixes to number types will set different byte orders while converting values. Following swap operations are available:

<div id="bkmrk-sw8---swap-every-pai"><div><div>- **SW8** - Swap every pair of bytes (8 bits) (e.g., **0xAABBCCDD** is translated to **0xBBAADDCC**);
- **SW16** - Swap every pair of words (16 bits) (e.g., **0xAABBCCDD** is translated to **0xCCDDAABB**);
- **SW32** - Swap every pair of two words (32 bits) (e.g., **0x1122334455667788** is translated to **0x5566778811223344**);

</div></div></div><span style="text-decoration: underline;">Table. Example of using different swapping functions:</span>

<table border="1" id="bkmrk-address-0-1-2-3-4-5-" style="border-collapse: collapse; width: 100%; height: 248px;"><tbody><tr style="height: 29px;"><td style="width: 27.9012%; height: 29px;">Address</td><td style="width: 10.8642%; height: 29px;">0</td><td style="width: 9.38258%; height: 29px;">1</td><td style="width: 8.88886%; height: 29px;">2</td><td style="width: 8.14825%; height: 29px;">3</td><td style="width: 8.76538%; height: 29px;">4</td><td style="width: 9.13576%; height: 29px;">5</td><td style="width: 8.76536%; height: 29px;">6</td><td style="width: 8.14814%; height: 29px;">7</td></tr><tr style="height: 45px;"><td style="width: 27.9012%; height: 45px;">Original number</td><td style="width: 10.8642%; height: 45px;">Byte 0</td><td style="width: 9.38258%; height: 45px;">Byte 1</td><td style="width: 8.88886%; height: 45px;">Byte 2</td><td style="width: 8.14825%; height: 45px;">Byte 3</td><td style="width: 8.76538%; height: 45px;">Byte 4</td><td style="width: 9.13576%; height: 45px;">Byte 5</td><td style="width: 8.76536%; height: 45px;">Byte 6</td><td style="width: 8.14814%; height: 45px;">Byte 7</td></tr><tr style="height: 29px;"><td style="width: 27.9012%; height: 29px;">SW8</td><td style="width: 10.8642%; height: 29px;">Byte 1</td><td style="width: 9.38258%; height: 29px;">Byte 0</td><td style="width: 8.88886%; height: 29px;">Byte 3</td><td style="width: 8.14825%; height: 29px;">Byte 2</td><td style="width: 8.76538%; height: 29px;">Byte 5</td><td style="width: 9.13576%; height: 29px;">Byte 4</td><td style="width: 8.76536%; height: 29px;">Byte 7</td><td style="width: 8.14814%; height: 29px;">Byte 6</td></tr><tr style="height: 29px;"><td style="width: 27.9012%; height: 29px;">SW16</td><td style="width: 10.8642%; height: 45px;">Byte 4</td><td style="width: 9.38258%; height: 45px;">Byte 5</td><td style="width: 8.88886%; height: 45px;">Byte 6</td><td style="width: 8.14825%; height: 45px;">Byte 7</td><td style="width: 8.76538%; height: 29px;">Byte 1</td><td style="width: 9.13576%; height: 29px;">Byte 6</td><td style="width: 8.76536%; height: 29px;">Byte 4</td><td style="width: 8.14814%; height: 29px;">Byte 5</td></tr><tr style="height: 29px;"><td style="width: 27.9012%; height: 29px;">SW32</td><td style="width: 10.8642%; height: 45px;">Byte 4</td><td style="width: 9.38258%; height: 45px;">Byte 5</td><td style="width: 8.88886%; height: 45px;">Byte 6</td><td style="width: 8.14825%; height: 45px;">Byte 7</td><td style="width: 8.76538%; height: 45px;">Byte 0</td><td style="width: 9.13576%; height: 45px;">Byte 1</td><td style="width: 8.76536%; height: 45px;">Byte 2</td><td style="width: 8.14814%; height: 45px;">Byte 3</td></tr><tr style="height: 29px;"><td style="width: 27.9012%; height: 29px;">SW8.SW16</td><td style="width: 10.8642%; height: 29px;">Byte 3</td><td style="width: 9.38258%; height: 45px;">Byte 2</td><td style="width: 8.88886%; height: 45px;">Byte 1</td><td style="width: 8.14825%; height: 45px;">Byte 0</td><td style="width: 8.76538%; height: 45px;">Byte 7</td><td style="width: 9.13576%; height: 45px;">Byte 6</td><td style="width: 8.76536%; height: 45px;">Byte 5</td><td style="width: 8.14814%; height: 45px;">Byte 4</td></tr><tr style="height: 29px;"><td style="width: 27.9012%; height: 29px;">SW8.SW32</td><td style="width: 10.8642%; height: 29px;">Byte 5</td><td style="width: 9.38258%; height: 45px;">Byte 4</td><td style="width: 8.88886%; height: 45px;">Byte 7</td><td style="width: 8.14825%; height: 45px;">Byte 6</td><td style="width: 8.76538%; height: 45px;">Byte 1</td><td style="width: 9.13576%; height: 45px;">Byte 0</td><td style="width: 8.76536%; height: 45px;">Byte 3</td><td style="width: 8.14814%; height: 45px;">Byte 2</td></tr><tr style="height: 29px;"><td style="width: 27.9012%; height: 29px;">SW8.SW16.SW32</td><td style="width: 10.8642%; height: 29px;">Byte 7</td><td style="width: 9.38258%; height: 45px;">Byte 6</td><td style="width: 8.88886%; height: 45px;">Byte 5</td><td style="width: 8.14825%; height: 45px;">Byte 4</td><td style="width: 8.76538%; height: 45px;">Byte 3</td><td style="width: 9.13576%; height: 45px;">Byte 2</td><td style="width: 8.76536%; height: 45px;">Byte 1</td><td style="width: 8.14814%; height: 45px;">Byte 0

</td></tr></tbody></table>

<p class="callout info">Where Byte x, means bit x position in the byte.</p>

Add a dot-separated prefix to the number format to use byte swapping. Multiple swap operations can be used simultaneously. For example, use `SW8.SW16.SIGNED32` it to correctly parse a 32-bit signed integer in a little-endian format. Table shows in detail how bytes, words, or double-words can be swapped and how swapping functions can be combined to make different swapping patterns. The table shows how byte swap is done for 64-bit (8-byte) numbers. It doesn’t matter if it is an unsigned/signed integer or double, byte swapping is considered a bit-level operation. If a number is shorter than 64 bits, the same logic applies, the only difference is the unavailability of some swapping operations (`SW32` for 32-bit and smaller numbers). Using such an unavailable operation might lead to undefined behavior.

### Linking signals

Signals can be linked together to achieve data transfer between several protocols. If a signal source is defined, all output from that source will be routed to the input of the target signal. This way events polled from a Modbus device (e.g., [Modbus](https://wiki.elseta.com/books/rtu-usage/page/modbus "Modbus protocol"), [IEC 60870-5](https://wiki.elseta.com/books/rtu-usage/chapter/protocols-configuration "Protocols - configuration"), etc.) can be delivered to an external station over a different protocol. A signal source is required if a signal is created on a slave protocol configuration to link events between protocols.

#### Example 1:

To read a coil state from a Modbus device and transfer it to [IEC 60870-5-104](https://wiki.elseta.com/books/rtu-usage/page/iec-60870-5-104 "IEC 60870-5-104") station, the following steps may be taken:

<div id="bkmrk-create-a-modbus-mast"><div><div>1. Create a Modbus master configuration in the Devices sheet.
2. Create an IEC 60870-5-104 slave configuration in the Devices sheet.
3. Create a signal on the master device to read coil status (function 1).
4. Create a signal on the slave device with a single point type (data\_type = 1).
5. Set **source\_device\_alias** and **source\_signal\_alias** fields on slave device signal to match **device\_alias** and **signal\_alias** on master device’s coil signal.

</div></div></div>#### Example 2

To write a coil state to a Modbus device on a command from [IEC 60870-5-104](https://wiki.elseta.com/books/rtu-usage/page/iec-60870-5-104) station, the following steps may be taken:

<div id="bkmrk-follow-steps-1-3-fro">1. Follow steps 1-3 from example 1.
2. Create a signal on the slave device with a single command type (data\_type = 45).
3. Set source\_device\_alias and source\_signal\_alias fields on the master configuration coil signal to match device\_alias and signal\_alias on the slave device’s command signal. Coil will be written to a value received by a command.
4. Set source\_device\_alias and source\_signal\_alias fields on the command signal to match device\_alias and signal\_alias on the master device’s coil signal. A command termination signal will be reported to the station on the coil write the result.

</div><p class="callout info">For additional information regarding the configuration of IEC 60870-5-101/103/104 protocols, please refer to ”[IEC 60780-5-101/103/104 PID interoperability for WCC Lite devices](https://wiki.elseta.com/link/180#bkmrk-pid%27s)”, accordingly.</p>

### Separators

These operators can be used when defining two or more values in a single cell. For example, source\_signal\_alias and source\_device\_alias from different signals have to be written in the same cell but separated by the separators listed below. This is useful when using the operation parameter when trying to do mathematical operations on more than one signal.

- “ “
- (newline)
- “;”
- “,”

# 18.3 Mathematical functions

Signal value might require some recalculation or signal update prior to being sent. Understandably, existing columns in Excel configuration like `multiply`, `add`, `bit_select` might not be flexible enough. To overcome these limitations, symbolic mathematical expressions can be configured to do calculations automatically on every update of a signal.

### Feature list:

- Optimized for speed 
    - High parsing performance
    - if-then-else operator with lazy evaluation
- Default implementation with many features 
    - 25 predefined functions
    - 18 predefined operators
- Unit support
    
    
    - Use postfix operators as unit multipliers (3m -&gt; 0.003)

### Mathematical functions

<span style="text-decoration: underline;">Table. Supported mathematical functions:</span>

<table border="1" id="bkmrk-name-argument-count-" style="border-collapse: collapse; width: 100%; height: 1002.14px;"><tbody><tr style="height: 46.5938px;"><td style="width: 33.3333%; height: 46.5938px;">Name</td><td style="width: 13.0503%; height: 46.5938px;">Argument count</td><td style="width: 53.6163%; height: 46.5938px;">Explanation</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">sin</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">sine function (rad)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">cos</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">cosine function (rad)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">tan</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">tangent function (rad)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">asin</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">arcus sine function (rad)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">acos</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">arcus cosine function (rad)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">atan</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">arcus tangent function (rad)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">sinh

</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">hyperbolic sine function

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">cosh</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">hyperbolic cosine

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">tanh</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">hyperbolic tangent function

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">asinh</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">hyperbolic arcus sine function

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">acosh</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">hyperbolic arcus tangent function

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">atanh</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">hyperbolic arcus tangent function

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">log2</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">logarithm to the base 2

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">log10</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">logarithm to the base 10

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">log</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">logarithm to base e (2.71828...)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">ln</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">logarithm to base e (2.71828...)

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">exp</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">e raised to the power of x

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">sqrt</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">square root of a value

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">sign</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">sign function -1 if x&lt;0; 1 if x&gt;0

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">rint</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">round to nearest integer

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">abs</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">absolute value

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">min</td><td style="width: 13.0503%; height: 35.3906px;">variable</td><td style="width: 53.6163%; height: 35.3906px;">min of all arguments

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">max</td><td style="width: 13.0503%; height: 35.3906px;">variable</td><td style="width: 53.6163%; height: 35.3906px;">max of all arguments

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">sum</td><td style="width: 13.0503%; height: 35.3906px;">variable</td><td style="width: 53.6163%; height: 35.3906px;">sum of all arguments

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">avg</td><td style="width: 13.0503%; height: 35.3906px;">variable</td><td style="width: 53.6163%; height: 35.3906px;">mean value of all arguments

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">floor</td><td style="width: 13.0503%; height: 35.3906px;">1</td><td style="width: 53.6163%; height: 35.3906px;">round down to the nearest integer

</td></tr><tr style="height: 35.3906px;"><td style="width: 33.3333%; height: 35.3906px;">mod</td><td style="width: 13.0503%; height: 35.3906px;">variable</td><td style="width: 53.6163%; height: 35.3906px;">modulo operation

</td></tr></tbody></table>

<p class="callout info">It should be noted that trigonometric functions (excluding hyperbolic functions) only support arguments in radians. This means that arguments for this function have to be recalculated if angle is defined in degrees.</p>

<p class="callout info">Value recalculation is only triggered on signal change of the preconfigured signal. That means that using other signals (via TagValue() call) does not trigger value update.</p>

<p class="callout warning">Some mathematical expression cannot be mathematically evaluated in some conditions, for example, square root cannot be found for negative numbers. As complex numbers are not supported, result is then equal to Not a Number (NaN). These results are marked with an invalid (IV) flag.</p>

### Binary operations

<span style="text-decoration: underline;">Table. Supported binary operators:</span>

<table border="1" id="bkmrk-operator-description" style="border-collapse: collapse; width: 100%; height: 530px;"><tbody><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">Operator</td><td style="width: 33.3333%; height: 29px;">Description</td><td style="width: 33.3333%; height: 29px;">Priority</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">=

</td><td style="width: 33.3333%; height: 35px;">assignment

</td><td style="width: 33.3333%; height: 35px;">-1</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">»

</td><td style="width: 33.3333%; height: 35px;">right shift

</td><td style="width: 33.3333%; height: 35px;">0</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">«

</td><td style="width: 33.3333%; height: 35px;">left shift

</td><td style="width: 33.3333%; height: 35px;">0</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">&amp;

</td><td style="width: 33.3333%; height: 35px;">bitwise and

</td><td style="width: 33.3333%; height: 35px;">0</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">|

</td><td style="width: 33.3333%; height: 35px;">bitwise or

</td><td style="width: 33.3333%; height: 35px;">0</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">&amp;&amp;

</td><td style="width: 33.3333%; height: 35px;">logical and

</td><td style="width: 33.3333%; height: 35px;">1</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">||

</td><td style="width: 33.3333%; height: 35px;">logical or

</td><td style="width: 33.3333%; height: 35px;">2</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">&lt;=

</td><td style="width: 33.3333%; height: 35px;">less or equal

</td><td style="width: 33.3333%; height: 35px;">4</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">&gt;=

</td><td style="width: 33.3333%; height: 35px;">greater or equal

</td><td style="width: 33.3333%; height: 35px;">4</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">!=

</td><td style="width: 33.3333%; height: 35px;">not equal

</td><td style="width: 33.3333%; height: 35px;">4</td></tr><tr style="height: 35px;"><td style="width: 33.3333%; height: 35px;">==

</td><td style="width: 33.3333%; height: 35px;">equal

</td><td style="width: 33.3333%; height: 35px;">4</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">&gt;</td><td style="width: 33.3333%; height: 29px;">greater than

</td><td style="width: 33.3333%; height: 29px;">4</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">&lt;</td><td style="width: 33.3333%; height: 29px;">less than

</td><td style="width: 33.3333%; height: 29px;">4</td></tr><tr><td style="width: 33.3333%;">+</td><td style="width: 33.3333%;">addition

</td><td style="width: 33.3333%;">5</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">-</td><td style="width: 33.3333%; height: 29px;">subtraction

</td><td style="width: 33.3333%; height: 29px;">5</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">\*</td><td style="width: 33.3333%; height: 29px;">multiplication

</td><td style="width: 33.3333%; height: 29px;">6</td></tr><tr><td style="width: 33.3333%;">/</td><td style="width: 33.3333%;">division

</td><td style="width: 33.3333%;">6</td></tr><tr><td style="width: 33.3333%;">^

</td><td style="width: 33.3333%;">raise x to the power of y

</td><td style="width: 33.3333%;">7</td></tr></tbody></table>

Ternary operators can be used. This expression can be compared to the operator supported by C/C++ language (Table 39). Condition is written before a question (?) sign. If condition is true, result after question sign is selected. If condition is false, result after colon (:) is selected.

### Ternary operations

<span style="text-decoration: underline;">Table. Supported ternary operators</span>

<table border="1" id="bkmrk-operator-description-0" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.3333%;">Operator</td><td style="width: 33.3333%;">Description</td><td style="width: 33.3333%;">Remarks</td></tr><tr><td style="width: 33.3333%;">?:

</td><td style="width: 33.3333%;">if then else operator

</td><td style="width: 33.3333%;">C++ style syntax

</td></tr></tbody></table>

### Examples

Users can construct their own equation by using the aforementioned operators and functions. These examples can be seen in Table below.

Table. Example expressions

<table border="1" id="bkmrk-expression-descripti" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">Expression

</td><td style="width: 50%;">Description

</td></tr><tr><td style="width: 50%;">value \* 0.0001

</td><td style="width: 50%;">Multiply the tag by a constant.

</td></tr><tr><td style="width: 50%;">value + TagValue(”tag/dev\_alias/sig\_alias/out”)

</td><td style="width: 50%;">Add value of tag/dev\_alias/sig\_alias/out to the current tag.

</td></tr><tr><td style="width: 50%;">sin(value)

</td><td style="width: 50%;">Return a predefined sine function value of the tag.

</td></tr><tr><td style="width: 50%;">(value&gt;5)? 1: 0

</td><td style="width: 50%;">If the value is greater than 5, the result should be equal to 1, otherwise - equal to 0

</td></tr></tbody></table>

Variable called "value" is generated or updated on every signal change and represents the signals being configured. If another value from tag list is intended to be used, one should use `TagValue()` function to retrieve its last value.

The inner argument of `TagValue()` function has to described in a Redis topic structure of WCC Lite. That means that it has to be constructed in a certain way. Quotes should be used to feed the topic name value, otherwise expression evaluation will fail.

Every Redis topic name is constructed as <span style="text-decoration: underline;">tag/\[device\_alias\]/\[signal\_alias\]/\[direction\]</span>. Prefix tag/ is always used before the rest of argument. `device_alias` and `signal_alias` represent columns in Excel configuration. Direction can have one of four possible values - rout, out, in, rin; all of which depend on the direction data is sent or acquired device-wise. For example, "out" keyword marks data sent out of WCC Lite device, whereas "in" direction represents data that WCC Lite is waiting to receive, for example, commands. Additional "r" before either direction means that data is raw, it is presented the way it was read by an individual protocol.

### Signal mathematics 

In this section you will be shown how "math\_expression" and other mathematical functions can be used in case of common signals. You can download configuration to follow along [here](https://wiki.elseta.com/attachments/119). Signals which we are concerned with in this section are highlighted in green color.

Let us analyze what mathematical functions are configured for the signals. For both second and third signals the same expression will be used: "**value + TagValue(”tag/Master/RHR0/out”)**". The only difference is that for the second signal scale function "add" was used.

[![image-1690294670075.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690294670075.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690294670075.png)

In this signal configuration the value of second signal is calculated by adding the current value of the second signal with the value of the first signal. Then the sum of two signals is going to be increased by 5. The third signal is going to be calculated in the same way except that 5 is not going to be added.

To see how it works let us start Modbus TCP Slave simulation in Vinci application. You can download the simulation [here](https://wiki.elseta.com/attachments/118).

[![image-1690352395491.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690352395491.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690352395491.png)

In the picture above you can see 6 registers. However our main focus is null, second and forth registers (Register0, Register2, Register4) since the first three signals of Modbus Master protocol (RHR0, RHR2 and RHR4) are reading the values of those registers (accordingly).

Let us go to WCC Lite web-interface to see how these signals are displayed there:

[![image-1690352275166.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690352275166.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690352275166.png)

As we can see the values of third and fifth signals have been modified (RHR2 = 2+1+5 = 8; RHR3 = 3+1 = 4). However the values of the signals that are displayed in the web-interface are intermediate so to speak. All the math is done in the protocol sevices (Modbus TCP Master in this case). Then those values are transmitted to REDIS service. The values that are displayed in the web-interface are REDIS values. We are going to see why it is important in another example.

Now it was mentioned that the values of third and fifth signals depend on the value of the first one. Let us see what will happen if we change the value of the Register 0. To do so we need to return to VINCI application. Locate Register 0 and double click on it. A menu with the register parameters will appear.

[![image-1690354650550.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690354650550.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690354650550.png)

Now let us change the value of the register to 2:

[![image-1690354747437.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690354747437.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690354747437.png)Now it would be expected that the value of second and third signals would become 9 and 5 accordingly (RHR2 = 2+2+5 = 9; RHR3 = 3+2 = 5). However if one would check WCC Lite web-interface right after that, one could notice that second and third signals remained unchanged:

[![image-1690355776501.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690355776501.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690355776501.png)

To explain this let us look again at the math expression of these signals. The equation (**value + TagValue(”tag/Master/RHR0/out”)**) consists of two operands "value" and "TagValue(”tag/Master/RHR0/out”)". Currently the system is designed in such a way that only if "value" operand has changed, only then there is going to be a change in a signal's value. So that if values of second and forth registers are changed (increased by one in this example) then the values of third and fifth signals are going to change taking into account the previous change in value of Register 0 (RHR2 = 2+3+5 = 10; RHR3 = 2+4 = 6).

[![image-1690357096636.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690357096636.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690357096636.png)

[![image-1690356862952.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690356862952.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690356862952.png)

### Command mathematics

In this section you will be shown how "math\_expression", and other mathematical functions can be used in case of command signals. You can download configuration to follow along [here](https://wiki.elseta.com/attachments/116). Signals which we are concerned with in this section are highlighted in blue color.

Let us analyze what mathematical functions are configured for the signals.

[![image-1690443715221.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690443715221.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690443715221.png)

First four signals are going to be used for scale function analysis. To see how it works let us start Modbus TCP Slave simulation in Vinci application. You can download the simulation [here](https://wiki.elseta.com/attachments/117).

[![image-1690366211464.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690366211464.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690366211464.png)

Let us go to WCC Lite web-interface to see how these signals are displayed there:

[![image-1690366270788.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690366270788.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690366270788.png)

As one can notice the values displayed in Vinci application differ from values displayed in web-interface. To better understand the results let us see step by step how signals are modified.

The first signal RHR0 reads the value of Register 0 which is equal to 4. After read operation the value is multiplied by two in the master protocol service. Then signal is transmitted to REDIS service. REDIS value is presented in web-interface. Then the same value 8 is written to Register 1 by sending WSR1 command signal. Finally the value of WSR1 signal is displayed in Vinci simulation.

The third signal RHR2 behaves quite the same as the first RHR0 signal. It reads value of Register 2 and without performing any scaling operations transmits value to REDIS. It again can be seen in the web-interface. While still in REDIS service the value of Register 2 is passed to WSR3 signal. Then command signal WSR3 is transmitted back to Modbus Master protocol service where the value of the signal is scaled. One could expect that the value of the signal would be multiplied by two but it is divided by two. Then the value of 2 is displayed in Vinci Slave simulation. After changing the value of Register 3 WSR3 signal is sent back from Master Protocol service to REDIS. On its way the signal again passes signal scaling place where it is again multiplied by two. This is why we see in the web-interface that the value of forth signal WSR3 is 4.

All the moments when a signal passes a place where its value is scaled can be seen by turning on a debugger session. To do so one should connect to WCC Lite via Ubuntu terminal in Terminal application. Then Modbus Master protocol needs to be stopped by sending "**/etc/init.d/modbus-master stop"**. Then Modbus Master protocol needs to be started again with -m flag (m for math) "**modbus-master -d7 -m -c /etc/modbus-master/modbus-tcp.json".**

[![image-1690374285270.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690374285270.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690374285270.png)

If you scroll up after starting the session you will be able to find how both RHR0 and WSR3 signals are scaled after passing signal scaling place.

[![image-1690374494803.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690374494803.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690374494803.png)

[![image-1690374525614.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690374525614.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690374525614.png)

Why is it the case that the signal is divided instead of being multiplied by two? The answer to this question is that scaling factor depends on the direction of the signal. When RHR0 signal was travelling from Master Protocol to REDIS service and was passing the place where signals are scaled the signal was multiplied by scaling factor. On the other hand when WSR3 signal was travelling from REDIS service to Master Protocol and was passing the same signal scaling place the signal was divided by scaling factor.

Now let us analyze how "math\_expression" and "source\_math\_expression" are applied to WSR5 signal. To get a better insight let us look how signals are transmitted and transformed inside WCC Lite and when mathematical expressions are applied.

[![image-1690454682295.drawio.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690454682295-drawio.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690454682295-drawio.png)

Let us analyze the diagram above. As we can see all basic mathematical operations (such as add, multiply, etc.) are performed inside a Master protocol service. When signals are transmitted between protocols they travel through REDIS service. The period of existence of a signal inside the REDIS service can be divided into four stages. They can be denoted by their endings, namely: "rout", "out", "in" and "rin". At "out" and "rin" stages signal values can be seen through certain interfaces that is why they are displayed in a purple color with blue eyes on them. At "out" stage a signal is displayed on WCC Lite web-interface, at "rin" stage signal value can be seen through Vinci application. As one could notice "math\_expression" is applied before "out" stage and "source\_math\_expression" is performed before "rin" stage.

However in our particular example we did not configure any Slave device. In this situation signal transportation inside REDIS service can be depicted as following:

[![image-1690446845504.drawio.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690446845504-drawio.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690446845504-drawio.png)

Let us return to our example and let us see what are the values of WSR5 signal in WCC Lite web-interface and Vinci Slave simulation.

[![image-1690451897495.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690451897495.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690451897495.png)

[![image-1690451946031.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690451946031.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690451946031.png)

The diagram below explains how these values were calculated.

[![image-1690452517897.drawio.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690452517897-drawio.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1690452517897-drawio.png)

### Extra functions

Several functions are defined make tag operations possible:

- `TagValue(key)` - returns last known value of tag identified by redis key;
- `TagFlag(key)` - returns 1 if tag flag exists. Name format is: ”key flag”. For example to check if tag is non topical, name would be ”tag/19xxxxxxx/x/x nt”;
- `TagAttribute(key)` - similar to TagFlag, but returns a numeric value of a tag attribute;
- `TagTime(key)` - returns UNIX timestamp in milliseconds of a last know tag value.

# 18.4 Uploading configuration

As of WCC Lite version v1.4.0, there are three separate ways to import the configuration: import an Excel file via the web interface, generate compressed configuration files and later upload them via the web interface; or generate compressed configuration files and upload them via utility application.

For WCC Lite versions v1.4.0, the name of the file is shown in Protocol Hub --&gt;Configuration. Older versions only allow configuration files to be stored to a file called phub.xlsx and later downloaded with a custom-built name reflecting the date of a download. Upgrade process from older version to versions v1.4.0 and above when preserving configuration files automatically makes the necessary changes to enable this new functionality of WCC Lite.

<p class="callout info">If a user intends to **downgrade** the firmware to versions older than version v1.4.0 from newer versions, they must first download the configuration files and later reupload the configuration after finishing the upgrade process.</p>

### Importing an Excel file

Excel files can be imported without any external tools. This option can be used where there is no internet connection or only minor change has to be applied. This way of importing is not suitable for the validation of Excel configuration files.

<p class="callout info">**Generating configuration is a resource-intensive task.** It might take up to 10 minutes depending on configuration complexity</p>

<p class="callout info">Supported types of an Excel configuration: .xlsx, .xlsm, .xltm, .xltx</p>

To upload an Excel file, open <span style="text-decoration: underline;">Protocol Hub --&gt;Configuration</span> screen in Web interface, select Configuration file, and press Import configuration.

### Generating .zip file

To accelerate the task of generating configuration a computer can be used. For this users should download the WCC Excel Utility application. Upon opening an application, the user should search for a field called Excel file which lets to choose an Excel file for which a conversion should be made. The output file should be filled out automatically, however, this value can be edited.

To make a conversion press Convert. If there are no errors found in the configuration, the output file should contain the generated configuration, otherwise, an error message is shown to a user.

This .zip file can be uploaded via the Web interface, using the same tools as used for import of an Excel file.

### Uploading configuration remotely

As of WCC Lite version, v1.4.0 generated configuration files can be uploaded with a click of a button in the Excel Utility. There are four parameters (not counting the configuration file itself) that have to be filled in before starting upload:

<div id="bkmrk-hostname%3A-an-ip-addr"><div>- *<span style="text-decoration: underline;">Hostname</span>*: an IP address for the device to connect to. This field conforms to hostname rules, therefore, if an invalid value is selected, it is reset to default (192.168.1.1);
- *<span style="text-decoration: underline;">Port</span>*: a PORT number to which an SSH connection can be made; valid values fall into a range between 1 and 65535; if an invalid value is selected, it is reset to default (22);
- *<span style="text-decoration: underline;">Username</span>*: a username which is used to make an SSH connection; make sure this user has enough rights, preferably root;
- *<span style="text-decoration: underline;">Password</span>*: a password of a user used for establishing an SSH connection;

</div></div><p class="callout info">Configuration can only be uploaded if a port used for SSH connection is open for IP address filled in the hostname entry field. Please check WCC Lite firewall settings in case of connection failure.</p>

To upload a configuration remotely, press Upload configuration. If no errors occur, you should finally be met with text output mentioning configuration has been applied. During the course of the upload process, the aforementioned button is disabled to prevent spanning multiple concurrent processes.

# 18.5 Virtual device

### General

The virtual device is a device that you can use to calculate additional math or keep a counter. It doesn't bind to any protocol and only works when its math expression is used.

<p class="callout success">Virtual device functionality is only available since firmware version v1.6.3, of WCC Lite.</p>

### Configuring Virtual device

To configure WCC Lite to use the virtual device you must configure the device and signal sheets.

*Virtual device parameters for Device tab:*

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 228px;"><tbody><tr style="height: 44px;"><td class="align-center" rowspan="2" style="width: 16.4814%; height: 54px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="width: 9.07411%; height: 54px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="width: 25.8644%; height: 54px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="width: 10.2777%; height: 54px;">**Required  
</td><td class="align-center" rowspan="2" style="width: 18.9044%; height: 54px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 44px; width: 19.3827%;">**Range**

</td></tr><tr style="height: 10px;"><td class="align-center" style="height: 10px; width: 9.62963%;">Min

</td><td class="align-center" style="width: 9.75309%; height: 10px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">name</td><td style="width: 9.07411%; height: 29px;">string</td><td style="width: 25.8644%; height: 29px;">User-friendly device name</td><td style="width: 10.2777%; height: 29px;">Yes</td><td style="width: 18.9044%; height: 29px;">  
</td><td style="width: 9.62963%; height: 29px;">  
</td><td style="width: 9.75309%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">description</td><td style="width: 9.07411%; height: 29px;">string</td><td style="width: 25.8644%; height: 29px;">Description of the device</td><td style="width: 10.2777%; height: 29px;">No</td><td style="width: 18.9044%; height: 29px;">  
</td><td style="width: 9.62963%; height: 29px;">  
</td><td style="width: 9.75309%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">device\_alias</td><td style="width: 9.07411%; height: 29px;">string</td><td style="width: 25.8644%; height: 29px;">Device alias to be used in the configuration</td><td style="width: 10.2777%; height: 29px;">Yes</td><td style="width: 18.9044%; height: 29px;">  
</td><td style="width: 9.62963%; height: 29px;">  
</td><td style="width: 9.75309%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 16.4814%; height: 29px;">protocol</td><td style="width: 9.07411%; height: 29px;">string</td><td style="width: 25.8644%; height: 29px;">Selection of protocol</td><td style="width: 10.2777%; height: 29px;">Yes</td><td style="width: 18.9044%; height: 29px;">  
</td><td colspan="2" style="width: 9.62963%; height: 29px;">**Virtual device**  
</td></tr></tbody></table>

*Virtual device parameters for Signals tab:*

<table border="1" id="bkmrk-parameter-type-descr-0" style="border-collapse: collapse; width: 100%; height: 455px;"><tbody><tr style="height: 44px;"><td class="align-center" rowspan="2" style="width: 17.0581%; height: 54px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="width: 8.40544%; height: 54px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="width: 38.814%; height: 54px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="width: 9.76453%; height: 54px;">**Required  
</td><td class="align-center" rowspan="2" style="width: 10.136%; height: 54px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 44px; width: 15.822%;">**Range**

</td></tr><tr style="height: 10px;"><td class="align-center" style="height: 10px; width: 7.911%;">Min

</td><td class="align-center" style="width: 7.911%; height: 10px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 17.0581%; height: 29px;">signal\_name</td><td style="width: 8.40544%; height: 29px;">string</td><td style="width: 38.814%; height: 29px;">User-friendly signal name</td><td style="width: 9.76453%; height: 29px;">Yes</td><td style="width: 10.136%; height: 29px;"></td><td style="width: 7.911%; height: 29px;">  
</td><td style="width: 7.911%; height: 29px;"></td></tr><tr style="height: 29px;"><td style="width: 17.0581%; height: 29px;">device\_alias</td><td style="width: 8.40544%; height: 29px;">string</td><td style="width: 38.814%; height: 29px;">Device alias from a Devices tab</td><td style="width: 9.76453%; height: 29px;">Yes</td><td style="width: 10.136%; height: 29px;">  
</td><td style="width: 7.911%; height: 29px;">  
</td><td style="width: 7.911%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.0581%; height: 29px;">signal\_alias</td><td style="width: 8.40544%; height: 29px;">string</td><td style="width: 38.814%; height: 29px;">Unique signal name to be used</td><td style="width: 9.76453%; height: 29px;">Yes</td><td style="width: 10.136%; height: 29px;">  
</td><td style="width: 7.911%; height: 29px;">  
</td><td style="width: 7.911%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 17.0581%; height: 29px;">math\_expression</td><td style="width: 8.40544%; height: 29px;">string</td><td style="width: 38.814%; height: 29px;">Field to calculate specific math.

You must enter the signal you want to use.

</td><td style="width: 9.76453%; height: 29px;">Yes</td><td style="width: 10.136%; height: 29px;">  
</td><td colspan="2" style="width: 15.822%; height: 29px;">  
</td></tr></tbody></table>

The only field that is a must to use the virtual device is the *math\_expression* field. Here you need to enter the signal which you want to associate it with. Some examples of what it can do:

- Hold a specific tag value.
- Calculate a specific math function with many signals, that you can, later on, pass to another device.
- Add tag value to the current value, to create a counter.

# 19 WCC Lite internal signals

### Overview

The WCC Lite contains several internal data points for readout and control which can be accessed via the Pooler service.

### Configuration

#### Devices section

In the devices section, only the protocol, scan\_rate\_ms and poll\_delay\_ms are to be configured for this type of device.

##### WCC Lite internal signals

<table border="1" id="bkmrk-parameter-descriptio" style="border-collapse: collapse; width: 100%; height: 174px;"><tbody><tr style="height: 29px;"><td style="width: 11.8518%; height: 29px;">**Parameter** </td><td style="width: 7.03703%; height: 29px;">**Type**</td><td style="width: 26.6667%; height: 29px;">**Description** </td><td style="width: 8.64204%; height: 29px;">**Required**</td><td style="width: 16.6667%; height: 29px;">**Default Value**

(when not specified)

</td><td style="width: 16.6667%; height: 29px;">**Range**

</td></tr><tr style="height: 29px;"><td style="width: 11.8518%; height: 29px;">name</td><td style="width: 7.03703%; height: 29px;">string

</td><td style="width: 26.6667%; height: 29px;">User-friendly device name</td><td style="width: 8.64204%; height: 29px;">Yes</td><td style="width: 16.6667%; height: 29px;"> </td><td style="width: 16.6667%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 11.8518%; height: 29px;">device\_alias</td><td style="width: 7.03703%; height: 29px;">string</td><td style="width: 26.6667%; height: 29px;">Alphanumeric string to identify a device</td><td style="width: 8.64204%; height: 29px;">Yes</td><td style="width: 16.6667%; height: 29px;"> </td><td style="width: 16.6667%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 11.8518%; height: 29px;">protocol</td><td style="width: 7.03703%; height: 29px;">  
</td><td style="width: 26.6667%; height: 29px;">Protocol identifier Internal data</td><td style="width: 8.64204%; height: 29px;">Yes</td><td style="width: 16.6667%; height: 29px;">  
</td><td style="width: 16.6667%; height: 29px;">**Internal data**</td></tr><tr style="height: 29px;"><td style="width: 11.8518%; height: 29px;">scan\_rate\_ms</td><td style="width: 7.03703%; height: 29px;">integer</td><td style="width: 26.6667%; height: 29px;">Update rate</td><td style="width: 8.64204%; height: 29px;">No</td><td style="width: 16.6667%; height: 29px;">60000</td><td style="width: 16.6667%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 11.8518%; height: 29px;">poll\_delay\_ms</td><td style="width: 7.03703%; height: 29px;">integer</td><td style="width: 26.6667%; height: 29px;">Poll delay</td><td style="width: 8.64204%; height: 29px;">No</td><td style="width: 16.6667%; height: 29px;">200</td><td style="width: 16.6667%; height: 29px;">  
</td></tr></tbody></table>

<p class="callout info">It is advised to set scan\_rate\_ms to a value greater than 5000 milliseconds as frequent scans may result in a significant overload of the internal data process.</p>

#### The signals section

`tag_job` defines the tag job. This can be set to `gpio`, `board`, `netstat`, `gsm`, `led` and `process`. `tag_job_todo` defines the job sub­ job. This field should address the particular point of interest. There is also an extra trigger parameter which is optional. It allows changing when the signal switches between on and off and is only applicable on LED and GPIO parameters that can be set. The default trigger is value&gt;0. When a **trigger** column is added the trigger can be changed by entering i.e. "value&gt;10". This is useful when mapping a source signal to for example trigger a relay. An example of how to use a trigger is in the example configuration which is attached to this page. <span style="color: #3598db;">[Excel Configuration Example](https://wiki.elseta.com/attachments/33)</span>

<p class="callout warning">Digital-input GPIO will only work with Hardware versions 1.4 and above.</p>

<p class="callout warning">Certain GSM parameters will only work if a sim card is inserted.</p>

<table border="1" id="bkmrk-tag_job-description-" style="border-collapse: collapse; width: 100%; height: 1759.38px;"><tbody><tr style="height: 29.8785px;"><td style="width: 24.9725%; height: 29.8785px;">**job\_todo**</td><td style="width: 24.9725%; height: 29.8785px;">**Description**</td><td style="width: 24.9725%; height: 29.8785px;">**tag\_job\_todo**</td><td style="width: 24.9725%; height: 29.8785px;">**Description**</td></tr><tr style="height: 82.4653px;"><td rowspan="6" style="height: 328.385px; width: 24.9725%;">gpio

</td><td data-colwidth="170" rowspan="2" style="height: 148.142px; width: 24.9725%;">ReadOnly parameters</td><td data-colwidth="170" style="width: 24.9725%; height: 82.4653px;">digital-input</td><td data-colwidth="170" style="width: 24.9725%; height: 82.4653px;">If the value is 1 then the digital input pin is high. If it's 0 then the digital-input value is low.</td></tr><tr style="height: 65.6771px;"><td data-colwidth="170" style="width: 24.9725%; height: 65.6771px;">rs232-enable

</td><td style="width: 24.9725%; height: 65.6771px;">If the value is 1 then rs232 is enabled. If the value is 0 then rs485 is enabled.</td></tr><tr style="height: 82.4653px;"><td rowspan="4" style="height: 180.243px; width: 24.9725%;">Parameters that can be set.</td><td data-colwidth="170" style="width: 24.9725%; height: 82.4653px;">sim-select

</td><td data-colwidth="170" style="width: 24.9725%; height: 82.4653px;">Switch between sim1 and sim2. If the **value** is 0 then sim1 is selected. If the value is 1 then sim2 is selected.</td></tr><tr><td style="width: 24.9725%;">sim-detect

</td><td style="width: 24.9725%;">Informs whether sim is inserted.</td></tr><tr style="height: 48.8889px;"><td data-colwidth="170" style="width: 24.9725%; height: 48.8889px;">modem-reset

</td><td style="width: 24.9725%; height: 48.8889px;">Making this value equal to 1 will reset the modem.</td></tr><tr style="height: 48.8889px;"><td data-colwidth="170" style="width: 24.9725%; height: 48.8889px;">relay

</td><td style="width: 24.9725%; height: 48.8889px;">Making this value equal to 1 will activate the relay.</td></tr><tr style="height: 35.4688px;"><td rowspan="8" style="height: 350.886px; width: 24.9725%;">board

</td><td rowspan="8" style="height: 350.886px; width: 24.9725%;">Board info

</td><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">cpu-usage

</td><td style="width: 24.9725%; height: 35.4688px;">CPU usage %</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">ram-usage

</td><td style="width: 24.9725%; height: 35.4688px;">RAM usage %</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">mac-address

</td><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">Device MAC address</td></tr><tr style="height: 35.4688px;"><td style="width: 24.9725%; height: 35.4688px;">uptime

</td><td style="width: 24.9725%; height: 35.4688px;">Device uptime in seconds</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">fw-version

</td><td style="width: 24.9725%; height: 35.4688px;">Firmware version</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">hw-version

</td><td style="width: 24.9725%; height: 35.4688px;">Hardware version</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">modem-imei

</td><td style="width: 24.9725%; height: 35.4688px;">Modem IMEI number</td></tr><tr style="height: 102.604px;"><td data-colwidth="170" style="width: 24.9725%; height: 102.604px;">modem-type

</td><td data-colwidth="170" style="width: 24.9725%; height: 102.604px;">Modem type:

0 - unknown

1 - single sim

2 - dual sim

</td></tr><tr style="height: 35.4688px;"><td rowspan="2" style="width: 24.9725%; height: 65.3473px;">netstat|\[interface\]</td><td rowspan="2" style="width: 24.9725%; height: 65.3473px;">Network statistics</td><td style="width: 24.9725%; height: 35.4688px;">TX

</td><td style="width: 24.9725%; height: 35.4688px;">Bytes transferred</td></tr><tr style="height: 29.8785px;"><td style="width: 24.9725%; height: 29.8785px;">RX</td><td style="width: 24.9725%; height: 29.8785px;">Bytes received</td></tr><tr style="height: 47.9167px;"><td rowspan="8" style="width: 24.9725%; height: 360.764px;">led

</td><td rowspan="8" style="width: 24.9725%; height: 360.764px;">LED status/control

</td><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">blue-heartbeat

</td><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">Heartbeat LED</td></tr><tr style="height: 47.9167px;"><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">blue-wlan

</td><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">WLAN LED</td></tr><tr style="height: 40.3646px;"><td style="width: 24.9725%; height: 40.3646px;">green-eth0</td><td style="width: 24.9725%; height: 40.3646px;">ETH0 LED</td></tr><tr style="height: 40.3646px;"><td style="width: 24.9725%; height: 40.3646px;">green-eth1</td><td style="width: 24.9725%; height: 40.3646px;">ETH1 LED</td></tr><tr style="height: 47.9167px;"><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">green-signal1

</td><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">Signal 1 LED</td></tr><tr style="height: 47.9167px;"><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">green-signal2

</td><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">Signal 2 LED</td></tr><tr style="height: 47.9167px;"><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">green-signal3

</td><td data-colwidth="170" style="width: 24.9725%; height: 47.9167px;">Signal 3 LED</td></tr><tr style="height: 40.4514px;"><td style="width: 24.9725%; height: 40.4514px;">red-fault</td><td style="width: 24.9725%; height: 40.4514px;">Fault LED</td></tr><tr style="height: 46.6667px;"><td style="width: 24.9725%; height: 46.6667px;">process</td><td style="width: 24.9725%; height: 46.6667px;">Check if the process is running</td><td style="width: 24.9725%; height: 46.6667px;">\[process name\]</td><td style="width: 24.9725%; height: 46.6667px;">1 or 0 is returned</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" rowspan="7" style="height: 248.282px; width: 24.9725%;">gsm

</td><td data-colwidth="170" rowspan="7" style="height: 248.282px; width: 24.9725%;">GSM information</td><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">rat-number

</td><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">GSM RAT number

</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">imsi-number

</td><td style="width: 24.9725%; height: 35.4688px;">GSM IMSI number</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">internet-status

</td><td style="width: 24.9725%; height: 35.4688px;">GSM Internet status</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">operator-number

</td><td style="width: 24.9725%; height: 35.4688px;">GSM operator number</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">roaming-status

</td><td style="width: 24.9725%; height: 35.4688px;">GSM roaming status</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">signal-quality

</td><td style="width: 24.9725%; height: 35.4688px;">GSM signal quality</td></tr><tr style="height: 35.4688px;"><td data-colwidth="170" style="width: 24.9725%; height: 35.4688px;">sim-status

</td><td style="width: 24.9725%; height: 35.4688px;">SIM card status</td></tr><tr style="height: 48.8889px;"><td data-colwidth="170" rowspan="6" style="width: 24.9725%; height: 329.167px;">date

</td><td data-colwidth="170" rowspan="6" style="height: 329.167px; width: 24.9725%;">Current set time values.</td><td data-colwidth="170" style="width: 24.9725%; height: 48.8889px;">year

</td><td style="width: 24.9725%; height: 48.8889px;">The current year set on the device</td></tr><tr style="height: 57.8472px;"><td data-colwidth="170" style="width: 24.9725%; height: 57.8472px;">month

</td><td data-colwidth="170" style="width: 24.9725%; height: 57.8472px;">The current month set on the device

</td></tr><tr style="height: 57.8472px;"><td data-colwidth="170" style="width: 24.9725%; height: 57.8472px;">day

</td><td data-colwidth="170" style="width: 24.9725%; height: 57.8472px;">The current day set on the device

</td></tr><tr style="height: 57.8472px;"><td data-colwidth="170" style="width: 24.9725%; height: 57.8472px;">hour

</td><td data-colwidth="170" style="width: 24.9725%; height: 57.8472px;">The current hour set on the device

</td></tr><tr style="height: 57.8472px;"><td data-colwidth="170" style="width: 24.9725%; height: 57.8472px;">minute

</td><td data-colwidth="170" style="width: 24.9725%; height: 57.8472px;">The current minute set on the device

</td></tr><tr style="height: 48.8889px;"><td data-colwidth="170" style="width: 24.9725%; height: 48.8889px;">second

</td><td style="width: 24.9725%; height: 48.8889px;">The current second set on the device</td></tr></tbody></table># 20 Programmable logic controller

A programmable logic controller (PLC) is a digital device adapted for control of processes which require high reliability, ease of programming and real­time responses. Such functionality has long since replaced hard­wired relays, timers and sequencers which would be required to complete various tasks.

Programmable logic controllers usually had to conform to IEC 61131­3 standard which defines four programming languages: function block diagram (FBD), ladder diagram (LD), structured text (ST) and sequential function chart (SFC). This standard does not support distributed control systems therefore IEC 61499 standard was published in 2005. The standard is considered an extension of IEC 61131­3 standard.

WCC Lite supports PLC functionality while conforming to specifications of IEC 61499 standard.

# 20.1 IEC 61499

IEC 61499-1 defines the architecture for distributed systems. In IEC 61499 the cyclic execution model of IEC 61131 is replaced by an event driven execution model. The event driven execution model allows for an explicit specification of the execution order of function blocks. If necessary, periodically executed applications can be implemented by using the E\_CYCLE function block for the generation of periodic events.

IEC 61499 enables an application-centric design, in which one or more applications, defined by networks of interconnected function blocks, are created for the whole system and subsequently distributed to the available devices. All devices within a system are described within a device model. The topology of the system is reflected by the system model. The distribution of an application is described within the mapping model. Therefore, applications of a system are distributable but maintained together.

Like IEC 61131-3 function blocks, IEC 61499 function block types specify both an interface and an implementation. In contrast to IEC 61131-3, an IEC 61499 interface contains event inputs and outputs in addition to data inputs and outputs. Events can be associated with data inputs and outputs by WITH constraints. IEC 61499 defines several function block types, all of which can contain a behavior description in terms of service sequences:

Service interface function block – SIFB: The source code is hidden and its functionality is only described by service sequences;  
• Basic function block - BFB: Its functionality is described in terms of an Execution Control Chart (ECC), which is similar to a state diagram (UML). Every state can have several actions. Each action references one or zero algorithms and one or zero events. Algorithms can be implemented as defined in compliant standards.  
• Composite function block - CFB: Its functionality is defined by a function block network.  
• Adapter interfaces: An adapter interface is not a real function block. It combines several events and data connections within one connection and provides an interface concept to separate specification and implementation.  
• Sub application: Its functionality is also defined as a function block network. In contrast to CFBs, sub applications can be distributed.

To maintain the applications on a device IEC 61499 provides a management model. The device manager maintains the lifecycle of any resource and manages the communication with the software tools (e.g., configuration tool, agent) via management commands.

# 20.2 4Diac framework

[![image-1601992021990.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992021990.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992021990.png)

The PLC functionality in the WCC Lite is implemented using Eclipse 4diac framework, consisting of the 4diac IDE and the 4diac FORTE runtime. The system corresponds to IEC 61499, an extension of IEC 61131-3. For more in-depth instructions and function block reference please see the 4diac manual - this document is merely a quick start guide that emphasizes the specifics of tailoring the applications to run on the WCC Lite.

  
The 4diac IDE application is used to model logic sequences. An output file, \*.fboot, is then generated and either loaded into the runtime for debugging purposes (functionality available from within the IDE), or uploaded into the controller for normal use via web interface.

<p class="callout warning">During debugging, the output logic is executed directly in the runtime. Any logic loaded during debugging will be discarded after a reboot of the controller. Logic applications for regular use should be uploaded via the web interface.</p>

<p class="callout info">It is possible to run multiple tasks at once. These tasks can either be implemented in the same screen or split into separate tasks. Please note, however, that all elements should have unique names, even between different tasks. As of 4diac IDE 1.11.3 this is not enforced between separate apps, however, 4Diac runtime application rejects such file purely because of naming issues.</p>

The 4diac FORTE runtime is able to execute the aforementioned fboot files containing the logic. The FORTE runtime can be run on both the WCC Lite and a PC for debugging purposes. The runtime is integrated to interact with the REDIS database.

# 20.3 Example project

The best way to understand basics of 4Diac and WCC Lite collaboration is through an example project. This user manual intends to show the pieces needed to run PLC applications on WCC Lite. It is not intended to be definitive guide on how to use 4Diac IDE or how to interpret IEC 61499 standard.

During (at least) the first start of the IDE user will be asked to select a directory for the workspace as in Figure. Workspace is used to save files needed for projects.

[![image-1601992159243.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992159243.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992159243.png)

[![image-1601992177394.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992177394.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992177394.png)

After that a user should be met by the welcome window. If such window is not shown, one can create project by selecting File --&gt;New --&gt; Project and filling in the required fields.

Here is a library of function blocks, which are working with the newest 4Diac version: [Elseta Library.zip](https://wiki.elseta.com/attachments/536). Upload the library to your project folder.

To create a simple application, simply drag and drop objects from the palette to the canvas and wire them accordingly. Event trigger and data pathways cannot be connected to one another. Displayed below is an example of a simple blinker application.

<p class="callout info">Having less wiring by connecting several signals to same subnet as PCB designer (such as Altium Designer) as of 4Diac IDE 1.11.3 is not supported. However, if some parts are used frequently, it is highly advised to have less wiring by simply compiling several elements into a sub application. For this, you would have to select elements to be grouped, press right key and select New Sub application. You can later change names of such elements and its pins.</p>

[![image-1601992239152.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992239152.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992239152.png)

[![image-1601992245178.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992245178.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992245178.png)

In the System Configuration section, drag and drop a FORTE\_PC device, an Ethernet segment and link them. For debugging in the local (PC) runtime, leave the address ”localhost:61499”. For testing on a WCC Lite, enter the IP address of the device, along with the port number (which by default is 61499 as well).

[![image-1601992273595.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992273595.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992273595.png)

In order to deploy the application, the circuit needs to be mapped to the controller. For a non-distributed application (distributed application cases will not be discussed in this chapter), all the FBs of the application need to be selected and mapped to the configured controller as shown:

[![image-1601992299991.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992299991.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992299991.png)

To start the application execution, an initial trigger needs to be present. For a non-distributed application, the initial event trigger needs to be wired from the START function block in the resource section as shown:

[![image-1601992323578.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992323578.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992323578.png)

[![image-1601992330383.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1601992330383.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992330383.png)

To deploy the application, go to the System Configuration tab and simply select ”Deploy” from the right-click menu of the controller device. If a running application exist in the runtime, you may be asked whether you want to replace it. This will only overwrite the application in the memory and not the storage. If the controller is restarted, the old application will be loaded from the non-volatile memory of the controller.

# 20.4 Configuring data endpoints

To use WCC Lite as a programmable logic controller, it needs to be configured in a particular way. The PLC functionality of the WCC Lite only allows for the use of data that is has been configured in the Excel configuration spreadsheet. This has been done for security purposes and to preserve transmission medium only for data that is available. Only topics defined in the configuration can post or get data. If a certain data entry exists but it has not been linked to a PLC program, all calls from PLC runtime application to redis database will be ignored. Therefore it is highly advised to prepare and upload the Excel configuration before using this signal in the PLC application.

Some parameters are mandatory for PLC usage. These parameters are shown in two tables below (one for Devices, one for Signals tab). Please note that other parameters can be used as well, but are not covered because they aren’t specific to PLC functionality.

<span style="text-decoration: underline;">Table. Mandatory parameters for Devices tab</span>

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 20.4938%;">Parameter</td><td style="width: 15.9259%;">Type</td><td style="width: 63.5802%;">Description</td></tr><tr><td style="width: 20.4938%;">name

</td><td style="width: 15.9259%;">string

</td><td style="width: 63.5802%;">User-friendly device name

</td></tr><tr><td style="width: 20.4938%;">device\_alias

</td><td style="width: 15.9259%;">string

</td><td style="width: 63.5802%;">Device alias to used in configuration

</td></tr><tr><td style="width: 20.4938%;">enable

</td><td style="width: 15.9259%;">boolean</td><td style="width: 63.5802%;">Enabling/disabling of a device

</td></tr><tr><td style="width: 20.4938%;">protocol

</td><td style="width: 15.9259%;">string

</td><td style="width: 63.5802%;">Selection of protocol (IEC 61499)

</td></tr></tbody></table>

<span style="text-decoration: underline;">Table. Mandatory parameters for Signals tab</span>

<table border="1" id="bkmrk-parameter-type-descr-0" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 20.4938%;">Parameter</td><td style="width: 15.9259%;">Type</td><td style="width: 63.5802%;">Description</td></tr><tr><td style="width: 20.4938%;">signal\_name

</td><td style="width: 15.9259%;">string

</td><td style="width: 63.5802%;">User-friendly signal name

</td></tr><tr><td style="width: 20.4938%;">device\_alias

</td><td style="width: 15.9259%;">string

</td><td style="width: 63.5802%;">Device alias from a Devices tab

</td></tr><tr><td style="width: 20.4938%;">signal\_alias

</td><td style="width: 15.9259%;">string</td><td style="width: 63.5802%;">Unique signal name to be used

</td></tr><tr><td style="width: 20.4938%;">source\_device\_alias

</td><td style="width: 15.9259%;">string

</td><td style="width: 63.5802%;">device\_alias of a source device

</td></tr><tr><td style="width: 20.4938%;">source\_signal\_alias

</td><td style="width: 15.9259%;">string

</td><td style="width: 63.5802%;">signal\_alias of a source signal

</td></tr></tbody></table>

If an upload consisting of configuration for IEC 61499 has been successful, one should be able to access a configuration stored in /etc/iec61499.json file where protocol-specific parameters are shown in a JSON format. If the file is missing, make sure you have a correct firmware version installed and haven’t made any typing errors.

Parameters mentioned earlier, namely device\_alias and signal\_alias, are the only parameters one needs to fill to bind Excel configuration to 4Diac framework. Two types of blocks are used for data transmission - PUBLISH blocks to write data to REDIS database and SUBSCRIBE blocks to acquire data from database as soon as it changes its value. Both of them have an ID connection. To connect a block to a data point, one should set this pin as raw\[\].redis\[device\_alias,signal\_alias\], e.g. raw\[\].redis\[example\_plc\_device,example\_plc\_signal\_alias\]. As of version 2.0.0 the pin values must be surrounded by double commas.

Examples with SUBSCRIBE and PUBLISH function blocks are shown in the images below.

<span style="text-decoration: underline;">Subscribe and publish example in the older versions</span>[![image-1602661793915.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1602661793915.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602661793915.png)

<span style="text-decoration: underline;">Subscribe and publish example in the newer versions (from 2.0.0)</span>

[![image-1691056876637.png](https://wiki.elseta.com/uploads/images/gallery/2023-08/scaled-1680-/image-1691056876637.png)](https://wiki.elseta.com/uploads/images/gallery/2023-08/image-1691056876637.png)

<p class="callout warning">Outputs of variable type ANY cannot be directly wired to inputs of the same type and therefore need to be explicitly typed using transitional function blocks.</p>

<p class="callout warning">No more than 20 tags should be published over a period of 5 seconds, as this may overfill the queue. A ”publish only on change” policy is advised.</p>

<p class="callout warning">Currently only PUBLISH\_1 and SUBSCRIBE\_1 function blocks are supported.</p>

<p class="callout warning">The functionality of the subscribe function is dependent on the presence of the "F\_STRING\_TO\_" function block, for example (F\_STRING\_TO\_REAL). Likewise, the publish function's proper operation relies on the availability of the "F\_ \_TO\_STRING" FB, for example (F\_REAL\_TO\_STRING).</p>

If every step until now has been successful, the user can now proceed to debug the PLC application.

# 20.5 Debugging an IEC 61499 application

After a project has been built and binded to an existing Excel configuration, a user would normally want to check if every part is working according to the prior requirements before compiling finished project and uploading it to production. Both 4Diac framework and WCC Lite offer tools for flexible debugging.

There is a possibility that 4Diac FORTE might not start as a process. It may happen if multiple faults occurred and process has stopped. Process is also programmed to not start if no excel configuration file is found, therefore a user should make sure that Excel configuration is uploaded and ready for use.

Individual function blocks can be set to Watch mode: events can be triggered and values can be forced at inputs or outputs (look into images bellow). To monitor the function blocks, the application should be deployed and the IDE should be in Online mode (Debug --&gt; Monitor System --&gt; NewSystem).

<span style="text-decoration: underline;">Selecting watch mode:</span>

[![image-1602662191072.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1602662191072.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662191072.png)

<span style="text-decoration: underline;">Function blocks in watch mode:</span>

[![image-1602662206569.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1602662206569.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662206569.png)

Seeing information dynamically updated on 4Diac IDE might be very informative, however, some applications might require accessing WCC Lite via command-line interface. For example, in case of information not being updated one would want to assure that 4Diac FORTE in WCC Lite is not filtering data out but sending it to internal database (Redis). To run 4Diac FORTE debug from command-line interface, a user should write forte and press Enter. All possible choices are shown by adding -h flag. A debugging example would be: '/etc/init.d/forte stop' to stop any forte processes, 'forte -d7 -r -f /etc/forte/yourfbootfilename.fboot' to launch the debug. More flags are shown in a Table bellow. Make sure to stop any running process that could use the address that 4Diac framework is going to use.

<span style="text-decoration: underline;">Table. 4Diac FORTE command line debugging options:</span>

```
-h - Display help information
-c <IP>:<port> - Set the listening IP and port for the incoming connections
-r - Show redis messages
-d <debug level> - Set debugging level
-f - Set the boot-file where to read from to load the applications
```

###   

# 20.6 Generating and uploading FORTE logic file

After the PLC design is finished and debugged, such design can be compiled into FBOOT file and uploaded to one or multiple devices to be used in production. As application being debugged is not automatically considered as a default application, one should be uploaded explicitly via web interface.

To generate FORTE boot-files a user should select <span style="color: #993300;">Run-&gt;Create FORTE boot-file....</span> After that one should select devices which should have their boot files created as well as additional devices’ properties and directory where these files should be stored as in picture bellow.

<span style="text-decoration: underline;">Generating FBOOT file:</span>[![image-1602662453356.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1602662453356.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662453356.png)

Upload button for FORTE file in web interface can be found in Protocol Hub tab, Configuration screen (FORTE boot file upload supported for versions v1.4.0 and above). You should see a view as in picture below.

<span style="text-decoration: underline;">WCC Lite Web interface. Upload and download of 4Diac configuration files:</span>

[![image-1689332420225.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689332420225.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689332420225.png)

After the file has been imported one should be able to download it from the same screen as seen in the picture before.

<p class="callout warning">Please note that only files with \*.fboot extension are allowed.</p>

<p class="callout info">Uploading a file saves it's name and shows it in the web interface. It is advised to carefully choose a filename to separate different versions of PLC application files.</p>

# 20.7 Distributed control application

IEC 64199 standard introduced requirements for a distributed control. This means that multiple devices can change information between them and make their own decisions based on the data they receive from other sources. This enables distributed applications between multiple WCC Lite devices and all other devices that support IEC 61499.

Communication between devices can be configured using:

- Publish/Subscribe function blocks (via UDP packets);
- Client/Server function blocks (via TCP packets).

A Publish block can publish data messages using UDP multi-cast addresses meaning that multiple devices would be able to simultaneously get the same data. However, one would have to make sure that all of the devices support multi-cast option.

This user manual will only cover setting up point-to-point communication between devices via Publish/Subscribe blocks. For more information on communication between several IEC 61499 devices please check documentation for [Eclipse 4diac framework](https://wiki.elseta.com/link/851#bkmrk-page-title).

Let’s say we would like to count how many times the light has been turned on. For this we can add counting functionality to application shown in picture below. The application should run on 2 devices. The blinking part of the application will run on a 4diac FORTE and the count on another 4diac FORTE, see the architecture below. The two different programs running on two separate WCC Lite devices emulate two PLCs. Two different devices can be identified by different colors of function blocks. One can identify device and it properties by accessing System Configuration screen as seen below. Yellow function blocks belong to WCC\_212 device which can be accessed through 192.168.4.212 (port number 61499) whereas brown function blocks belong to WCC\_218 device which can accessed through 192.168.4.218 (port number 61499).

<span style="text-decoration: underline;">Example blinking application as a distributed system:</span>[![image-1602662769321.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1602662769321.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662769321.png)

<span style="text-decoration: underline;">Example system configuration for a distributed system:</span>[![image-1602662862391.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1602662862391.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662862391.png)

<span style="text-decoration: underline;">Example app for blinking part of a distributed system:</span>[![image-1602662875556.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1602662875556.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662875556.png)

<span style="text-decoration: underline;">Example app for counting part of a distributed system:</span>[![image-1602662888137.png](https://wiki.elseta.com/uploads/images/gallery/2020-10/scaled-1680-/image-1602662888137.png)](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662888137.png)

To count the blinking, two new Function Blocks (FBs) have been added to the existing application for a different device (WCC\_218):

- E\_PERMIT
- E\_CTU

To communicate between devices, an additional PUBLISH\_X/SUBSCRIBE\_X pair must be used. As one can identify, these blocks are not seen when looking at a whole distributed system and should be seen as an intermediary between devices.

The PUBLISH\_X FB is used to send messages over the network which are received by an according SUBSCRIBE\_X FB. Every time a REQ is triggered, a message is sent according to the ID input. With the value of the ID input you can specify what specific network protocol you would like to use (e.g., MQTT). If you don’t specify a dedicated protocol the default as defined in the ”IEC 61499 Compliance Profile for Feasibility Demonstrations” is used. The number X in PUBLISH\_X is the number of data elements that you want to send in the message. Since we are only sending one value we used PUBLISH\_1.

The used ID value specifies an IP:PORT pair.

# 21 Lua script runner

### Introduction

Lua is a powerful, efficient, lightweight scripting language. It has been used in many industrial applications with an emphasis on embedded systems. Lua has a deserved reputation for performance. To claim to be "as fast as Lua" is an aspiration of other scripting languages. Several benchmarks show Lua as the fastest language in the realm of interpreted scripting languages. Lua is fast not only in fine-tuned benchmark programs, but in real life too. Substantial fractions of large applications have been written in Lua.

In WCC Lite system Lua is used for extending the functionality of excel configuration adding an interface to the existing signal-linking engine. Provided functions enable to recreate PLC functionality and modify any value with ease.

### Overview

##### Execution types:

Lua runner provides 3 execution modes: interval, date, signal, which can be specified in [**execution\_type**](https://wiki.elseta.com/link/915#bkmrk-parameter-descriptio-0).

**Interval**: executes provided script based on provided time interval in [**execution\_parameter**](https://wiki.elseta.com/link/915#bkmrk-parameter-descriptio-0). It uses milliseconds, meaning if 500 value is provided, then the script is executed every 500 milliseconds.  
**Date:** schedules a script execution based on provided cron expression in [**execution\_parameter**](https://wiki.elseta.com/link/915#bkmrk-parameter-descriptio-0). The format consists of 6-7 fields separated by space.

<table border="1" cellpadding="3" cellspacing="0" class="Formal" dir="ltr" frame="hsides" id="bkmrk-name-required-allowe" rules="groups" summary="Cron Expressions Allowed Fields and Values" title=" Cron Expressions Allowed Fields and Values" width="100%"><thead><tr align="left" valign="top"><th align="left" id="bkmrk-name" style="width: 24.9691%;" valign="bottom">Name</th><th align="left" id="bkmrk-required" style="width: 10.5068%;" valign="bottom">Required</th><th align="left" id="bkmrk-allowed-values" style="width: 21.8815%;" valign="bottom">Allowed Values</th><th align="left" id="bkmrk-allowed-special-char" style="width: 42.519%;" valign="bottom">Allowed Special Characters</th></tr></thead><tbody><tr align="left" valign="top"><td align="left" headers="r1c1-t2" id="bkmrk-seconds" style="width: 24.9691%;">Seconds

</td><td align="left" headers="r2c1-t2 r1c2-t2" style="width: 10.5068%;">Y

</td><td align="left" headers="r2c1-t2 r1c3-t2" style="width: 21.8815%;">0-59

</td><td align="left" headers="r2c1-t2 r1c4-t2" style="width: 42.519%;">, - \* /

</td></tr><tr align="left" valign="top"><td align="left" headers="r1c1-t2" id="bkmrk-minutes" style="width: 24.9691%;">Minutes

</td><td align="left" headers="r3c1-t2 r1c2-t2" style="width: 10.5068%;">Y

</td><td align="left" headers="r3c1-t2 r1c3-t2" style="width: 21.8815%;">0-59

</td><td align="left" headers="r3c1-t2 r1c4-t2" style="width: 42.519%;">, - \* /

</td></tr><tr align="left" valign="top"><td align="left" headers="r1c1-t2" id="bkmrk-hours" style="width: 24.9691%;">Hours

</td><td align="left" headers="r4c1-t2 r1c2-t2" style="width: 10.5068%;">Y

</td><td align="left" headers="r4c1-t2 r1c3-t2" style="width: 21.8815%;">0-23

</td><td align="left" headers="r4c1-t2 r1c4-t2" style="width: 42.519%;">, - \* /

</td></tr><tr align="left" valign="top"><td align="left" headers="r1c1-t2" id="bkmrk-day-of-month" style="width: 24.9691%;">Day of month

</td><td align="left" headers="r5c1-t2 r1c2-t2" style="width: 10.5068%;">Y

</td><td align="left" headers="r5c1-t2 r1c3-t2" style="width: 21.8815%;">1-31

</td><td align="left" headers="r5c1-t2 r1c4-t2" style="width: 42.519%;">, - \* /

</td></tr><tr align="left" valign="top"><td align="left" headers="r1c1-t2" id="bkmrk-month" style="width: 24.9691%;">Month

</td><td align="left" headers="r6c1-t2 r1c2-t2" style="width: 10.5068%;">Y

</td><td align="left" headers="r6c1-t2 r1c3-t2" style="width: 21.8815%;">0-11 or JAN-DEC

</td><td align="left" headers="r6c1-t2 r1c4-t2" style="width: 42.519%;">, - \* /

</td></tr><tr align="left" valign="top"><td align="left" headers="r1c1-t2" id="bkmrk-day-of-week" style="width: 24.9691%;">Day of week

</td><td align="left" headers="r7c1-t2 r1c2-t2" style="width: 10.5068%;">Y

</td><td align="left" headers="r7c1-t2 r1c3-t2" style="width: 21.8815%;">1-7 or SUN-SAT

</td><td align="left" headers="r7c1-t2 r1c4-t2" style="width: 42.519%;">, - \* /

</td></tr><tr align="left" valign="top"><td align="left" headers="r1c1-t2" id="bkmrk-year" style="width: 24.9691%;">Year

</td><td align="left" headers="r8c1-t2 r1c2-t2" style="width: 10.5068%;">N

</td><td align="left" headers="r8c1-t2 r1c3-t2" style="width: 21.8815%;">empty or 1970-2099

</td><td align="left" headers="r8c1-t2 r1c4-t2" style="width: 42.519%;">, - \* /

</td></tr></tbody></table>

For example, 0 0 \* \* \* \* will execute the script at every hour mark. There are a lot of online cron expression parsers or generators to convert this expression to a more understandable sentence. [https://crontab.cronhub.io/](https://crontab.cronhub.io/)

**Signal:** uses source signal provided in signal sheet to trigger script execution. Another non excel signal can be provided in [**execution\_parameter**](https://wiki.elseta.com/link/915#bkmrk-parameter-descriptio-0) attribute. As an example, if a signal in excel configuration has an attribute **execute** with value 1, and a source signal specified in **source\_device\_alias, source\_signal\_alias**, then if a value event happens to the source signal, the script will be executed. More than one signal can have **execute** attribute. The signal that executes the script can be accessed through the **execution\_signal** variable that has a table inside of it with variables: {tag = {device\_alias = "script", signal\_alias = "tag1"}, value = {value = 60, time = "123456789", attributes = "iv,nt,sb"}}

##### Additional functions:

To interface with existing signals and extend the available Lua functions some extra functions were added:

**get, set, publish,** and **subscribe** functions are used to get the values configured in excel configuration or to communicate with other scripts.  
A signal value in WCC Lite system consists of 3 sub-values: **value**, **time**, and **attributes. get** function is used to get all the sub-values or **get\_value**, **get\_time** and **get\_attributes** to get only one of the sub-values. To execute this command, a signal has to be specified: **get(signal.value1).** A signal is specified by a string "tag/&lt;device\_alias&gt;/&lt;signal\_alias&gt;" or a table that is created from **iterator** parameter in excel configuration. For example:

```Lua
-- the default iterator is signals, that means there is a table 'signals' generated from excel signals<br></br>-- signals["tag1"] = "tag/device_alias/tag1" tag1 would be the signal_alias<br></br>-- to get the value of this signal:<br></br>local variable = get_value(signals.tag1)<br></br>local variable = get_value(signals["tag1"]) -- both methods are viable<br></br>-- and the 'variable' will have the value of tag1 signal<br></br>-- get function will return the value of source signal that was sent to this signal
```

Function **publish** is used to send a value to other signals:

```Lua
publish(signals.tag2, 90) -- this function will send 90 with current time to the signal tag2<br></br>publish(signals.tag2, {value = 60, time = "123456789", attributes = "iv,nt,sb"})<br></br>-- above command is used when other sub values are needed to be specified<br></br>-- and the signal-linker will send it to another signal<br></br>-- if this signal was specified as source signal in another protocol signal
```

To provide different time and attributes to the publish function, a table of these 3 values has to be specified, time can be omitted. An example of the table is returned by the **get** function.

These two functions will be used the most, others are included for communication between different scripts in a more complex system.

**set** function set the value of the signal, without sending an event of change:

```Lua
set(signals.tag3, 50) -- this command will set the value of the signal tag3<br></br>-- because it is a set function, other protocols will not see a change<br></br>-- and the value will not be accessible<br></br>-- it is only used with non excel signals<br></br>set("signal1", 60) -- now the signal1 tag will have a value<br></br>-- and another script will be able to use get to get this value<br></br>local value1 = get_value("signal1") -- value1 will be equal to 60 with current time
```

Function **subscribe** is used to wait (blocks code execution while waiting) for a value and get it. It is used the same as **get** function (does not have separate functions for sub-values). It should only be used if more complex communication between scripts is needed.

<p class="callout info">These functions are equivalent to REDIS functions.</p>

Function **save** saves the specified value to flash memory for use after reboot. The same value sub-values apply to execution.

```Lua
save(signals.tag1, 50) -- this will save a value to tag1<br></br>-- after reboot this value will be set to tag1<br></br>-- and will be accesible with get(signals.tag1)<br></br>-- this function will not set the value tag1 to 50
```

Function **time\_ms** returns the current time in milliseconds and in UNIX format.

```Lua
local t = time_ms()<br></br>-- t will be equal to 1665389490555<br></br>-- if the date right now is Mon Oct 10 2022 08:11:30:555 GMT+0000
```

Function **sleep** is the same as Lua socket module function socket.sleep.

```Lua
sleep(1) -- will wait for 1 second
```

Additional functions for debug information are: **emerg, alert, crit, err, warning, notice, info, debug**. These functions correspond to levels from 0 to 7. The default level is 4, which means that the function from **emerg** to **warning** will be printed to syslog, unless specified differently in file **/etc/lua-runner.conf.**

```Lua
emerg("log message 0")<br></br>alert("log message 1")<br></br>crit("log message 2")<br></br>err("log message 3")<br></br>warning("log message 4")<br></br>notice("log message 5")<br></br>info("log message 6")<br></br>debug("log message 7")
```

<p class="callout warning">These functions will require significant CPU resources even if the message log level is higher than default and no message is printed.</p>

##### Web interface

The web interface is used to see what scripts are running, if there is a script provided, to stop/start a script. After configuring a device with Lua runner as protocol, the script runner protocol hub tab will be populated with devices that were configured:

[![image-1665406373895.png](https://wiki.elseta.com/uploads/images/gallery/2022-10/scaled-1680-/image-1665406373895.png)](https://wiki.elseta.com/uploads/images/gallery/2022-10/image-1665406373895.png)

Then by pressing the Upload Script button, a script will be available to be selected (the name of the script will be changed to match device\_alias). When uploaded the script will not be started automatically, pressing start will be necessary.

[![image-1665408922682.png](https://wiki.elseta.com/uploads/images/gallery/2022-10/scaled-1680-/image-1665408922682.png)](https://wiki.elseta.com/uploads/images/gallery/2022-10/image-1665408922682.png)

After pressing start, the script will be started, if there are errors it will try to start, but after a few attempts, it will stop.

[![image-1665409121771.png](https://wiki.elseta.com/uploads/images/gallery/2022-10/scaled-1680-/image-1665409121771.png)](https://wiki.elseta.com/uploads/images/gallery/2022-10/image-1665409121771.png)

The clear all saved values button is used to clear the memory of saved values. Having a lot of values saved is not healthy for the SD card and faults can happen. Also, the script runner process initialization is slowed down when a lot of saved values are used.

### Configuration

#### Device configuration parameters:

<table border="1" id="bkmrk-parameter-descriptio-0" style="border-collapse: collapse; width: 100%; height: 548.4px;"><tbody><tr style="height: 63.5333px;"><td class="align-center" rowspan="2" style="height: 115.8px; width: 19.649%;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 115.8px; width: 9.14398%;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 115.8px; width: 30.5248%;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 115.8px; width: 9.88631%;">**Required  
</td><td class="align-center" rowspan="2" style="height: 115.8px; width: 13.5937%;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 63.5333px; width: 17.301%;">**Range**

</td></tr><tr style="height: 52.2667px;"><td class="align-center" style="height: 52.2667px; width: 8.65052%;">Min

</td><td class="align-center" style="height: 52.2667px; width: 8.65052%;">Max

</td></tr><tr style="height: 40.6px;"><td style="width: 19.649%; height: 40.6px;">name

</td><td style="width: 9.14398%; height: 40.6px;">string</td><td style="width: 30.5248%; height: 40.6px;">User-­friendly name for a device

</td><td style="width: 9.88631%; height: 40.6px;">Yes</td><td style="width: 13.5937%; height: 40.6px;">  
</td><td style="width: 8.65052%; height: 40.6px;">  
</td><td style="width: 8.65052%; height: 40.6px;">  
</td></tr><tr><td data-colwidth="97.14" style="width: 19.649%;">device\_alias

</td><td data-colwidth="97.14" style="width: 9.14398%;">string

</td><td data-colwidth="97.14" style="width: 30.5248%;">Alphanumeric string to identify a device

</td><td data-colwidth="97.14" style="width: 9.88631%;">Yes

</td><td style="width: 13.5937%;">  
</td><td style="width: 8.65052%;">  
</td><td style="width: 8.65052%;">  
</td></tr><tr style="height: 40.6px;"><td style="width: 19.649%; height: 40.6px;">description</td><td style="width: 9.14398%; height: 40.6px;">string</td><td style="width: 30.5248%; height: 40.6px;">Description of a device

</td><td style="width: 9.88631%; height: 40.6px;">No</td><td style="width: 13.5937%; height: 40.6px;">  
</td><td style="width: 8.65052%; height: 40.6px;">  
</td><td style="width: 8.65052%; height: 40.6px;">  
</td></tr><tr style="height: 49.4px;"><td style="width: 19.649%; height: 49.4px;">enable  
</td><td style="width: 9.14398%; height: 49.4px;">boolean  
</td><td style="width: 30.5248%; height: 49.4px;">Enabling/disabling of a device

</td><td style="width: 9.88631%; height: 49.4px;">No  
</td><td style="width: 13.5937%; height: 49.4px;">1  
</td><td style="width: 8.65052%; height: 49.4px;">0  
</td><td style="width: 8.65052%; height: 49.4px;">1  
</td></tr><tr style="height: 35.4px;"><td data-colwidth="130" style="width: 19.649%; height: 35.4px;">protocol

</td><td data-colwidth="86" style="width: 9.14398%; height: 35.4px;">string

</td><td data-colwidth="117" style="width: 30.5248%; height: 35.4px;">Protocol to be used

</td><td data-colwidth="99" style="width: 9.88631%; height: 35.4px;">Yes

</td><td data-colwidth="108" style="width: 13.5937%; height: 35.4px;"></td><td colspan="2" data-colwidth="108,108" style="width: 17.301%; height: 35.4px;">lua runner

</td></tr><tr style="height: 57.8px;"><td data-colwidth="130" style="width: 19.649%; height: 57.8px;">execution\_type

</td><td data-colwidth="86" style="width: 9.14398%; height: 57.8px;">string

</td><td data-colwidth="117" style="width: 30.5248%; height: 57.8px;">Execution type to be used

</td><td data-colwidth="99" style="width: 9.88631%; height: 57.8px;">Yes

</td><td data-colwidth="108" style="width: 13.5937%; height: 57.8px;"></td><td colspan="2" data-colwidth="108,108" style="width: 17.301%; height: 57.8px;">interval, date, signal

</td></tr><tr style="height: 102.6px;"><td data-colwidth="130" style="width: 19.649%; height: 102.6px;">execution\_parameter

</td><td data-colwidth="86" style="width: 9.14398%; height: 102.6px;">int, string

</td><td data-colwidth="117" style="width: 30.5248%; height: 102.6px;">Parameters for execution

</td><td data-colwidth="99" style="width: 9.88631%; height: 102.6px;">Yes

</td><td data-colwidth="108" style="width: 13.5937%; height: 102.6px;"><div><div>NULL</div></div></td><td colspan="2" data-colwidth="108,108" style="width: 17.301%; height: 102.6px;">interval time in ms,  
date in cron format,  
additional signal

</td></tr><tr style="height: 35.4px;"><td data-colwidth="130" style="width: 19.649%; height: 35.4px;">queue\_max

</td><td data-colwidth="86" style="width: 9.14398%; height: 35.4px;">int

</td><td data-colwidth="117" style="width: 30.5248%; height: 35.4px;">Maximum execution queue jobs

</td><td data-colwidth="99" style="width: 9.88631%; height: 35.4px;">No

</td><td data-colwidth="108" style="width: 13.5937%; height: 35.4px;">3

</td><td colspan="2" data-colwidth="108,108" style="width: 17.301%; height: 35.4px;">0 to disable queue

</td></tr><tr style="height: 35.4px;"><td data-colwidth="130" style="width: 19.649%; height: 35.4px;">error\_limit

</td><td data-colwidth="86" style="width: 9.14398%; height: 35.4px;">int

</td><td data-colwidth="117" style="width: 30.5248%; height: 35.4px;">Error limit before stopping

</td><td data-colwidth="99" style="width: 9.88631%; height: 35.4px;">No

</td><td data-colwidth="108" style="width: 13.5937%; height: 35.4px;">3

</td><td colspan="2" data-colwidth="108,108" style="width: 17.301%; height: 35.4px;">0 to disable

</td></tr><tr style="height: 35.4px;"><td data-colwidth="130" style="width: 19.649%;">keep\_alive\_time\_ms

</td><td data-colwidth="86" style="width: 9.14398%;">int

</td><td data-colwidth="117" style="width: 30.5248%;">Time to keep the script alive in milliseconds

</td><td data-colwidth="99" style="width: 9.88631%;">No

</td><td data-colwidth="108" style="width: 13.5937%;">600000

</td><td colspan="2" data-colwidth="108,108" style="width: 17.301%;">0 to disable

</td></tr></tbody></table>

#### Signals configuration parameters:

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 548.4px;"><tbody><tr style="height: 63.5333px;"><td class="align-center" rowspan="2" style="height: 115.8px; width: 19.6539%;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 115.8px; width: 7.41656%;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 115.8px; width: 32.2621%;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 115.8px; width: 9.88875%;">**Required  
</td><td class="align-center" rowspan="2" style="height: 115.8px; width: 13.597%;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 63.5333px; width: 17.3053%;">**Range**

</td></tr><tr style="height: 52.2667px;"><td class="align-center" style="height: 52.2667px; width: 8.65266%;">Min

</td><td class="align-center" style="height: 52.2667px; width: 8.65266%;">Max

</td></tr><tr style="height: 40.6px;"><td style="width: 19.6539%; height: 40.6px;">signal\_name

</td><td style="width: 7.41656%; height: 40.6px;">string</td><td style="width: 32.2621%; height: 40.6px;">User-­friendly name for a signal

</td><td style="width: 9.88875%; height: 40.6px;">Yes</td><td style="width: 13.597%; height: 40.6px;">  
</td><td style="width: 8.65266%; height: 40.6px;">  
</td><td style="width: 8.65266%; height: 40.6px;">  
</td></tr><tr><td data-colwidth="97.14" style="width: 19.6539%;">device\_alias

</td><td data-colwidth="97.14" style="width: 7.41656%;">string

</td><td data-colwidth="97.14" style="width: 32.2621%;">Alphanumeric string to identify a device

</td><td data-colwidth="97.14" style="width: 9.88875%;">Yes

</td><td style="width: 13.597%;">  
</td><td colspan="2" style="width: 17.3053%;">Must match device\_alias in the device sheet  
</td></tr><tr><td data-colwidth="97.14" style="width: 19.6539%;">signal\_alias

</td><td data-colwidth="97.14" style="width: 7.41656%;">string

</td><td data-colwidth="97.14" style="width: 32.2621%;">Unique alphanumeric name of the signal to be Yes used

</td><td data-colwidth="97.14" style="width: 9.88875%;">Yes

</td><td style="width: 13.597%;">  
</td><td style="width: 8.65266%;">  
</td><td style="width: 8.65266%;">  
</td></tr><tr><td data-colwidth="97.14" style="width: 19.6539%;">iterator

</td><td data-colwidth="97.14" style="width: 7.41656%;">string

</td><td data-colwidth="97.14" style="width: 32.2621%;">Lua table name to which signal is added

</td><td data-colwidth="97.14" style="width: 9.88875%;">No

</td><td data-colwidth="97.14" style="width: 13.597%;">signals

</td><td data-colwidth="97.14" style="width: 8.65266%;"></td><td data-colwidth="97.14" style="width: 8.65266%;"></td></tr><tr><td data-colwidth="97.14" style="width: 19.6539%;">default\_value

</td><td data-colwidth="97.14" style="width: 7.41656%;">string

</td><td data-colwidth="97.14" style="width: 32.2621%;">Default value for a signal

</td><td data-colwidth="97.14" style="width: 9.88875%;">No

</td><td data-colwidth="97.14" style="width: 13.597%;"></td><td data-colwidth="97.14" style="width: 8.65266%;"></td><td data-colwidth="97.14" style="width: 8.65266%;"></td></tr><tr><td data-colwidth="97.14" style="width: 19.6539%;">execute

</td><td data-colwidth="97.14" style="width: 7.41656%;">int

</td><td data-colwidth="97.14" style="width: 32.2621%;">Enable signal update trigger to execute script (only available for signal execution mode)

</td><td data-colwidth="97.14" style="width: 9.88875%;">No

</td><td data-colwidth="97.14" style="width: 13.597%;">0

</td><td data-colwidth="97.14" style="width: 8.65266%;">0

</td><td data-colwidth="97.14" style="width: 8.65266%;">1

</td></tr></tbody></table>

### Debugging the script runner service

If configuration for script runner is set up, the process will start automatically. If configuration/script is missing or contains errors, process will not start. It is done intentionally decrease unnecessary memory usage.

Script runner runs a service called **lua-runner**. If the script doesn't start or does not work correctly, a user can launch a debug session from command line interface and find out what problem is causing it to not work. To launch a debugging session, a user should stop the script from web interface and run **lua-runner** command with respective flags and configuration as in the table given below.

Procedure for lua-runner service debugging:

- **Step 1**: Script must be stopped through web interface.
- **Step 2**: After script is stopped it must be started with the preferred configuration file (JSON files found in /etc/lua-runner, and the name corresponds to device\_alias) and a debug level 7: **lua-runner ­-c /etc/lua-runner/device\_alias.json ­-d7 -e.**
- **Step 3**: Once the problem is diagnosed normal operations can be resumed by starting the script through web interface.# 22 MQTT

### Introduction

MQTT (short for MQ Telemetry Transport) is an open OASIS and ISO standard (ISO/IEC PRF 20922) lightweight, publish-subscribe network protocol that transports messages between devices. The protocol usually runs over TCP/IP, although its variant, MQTT-SN, is used over other transports such as UDP or Bluetooth. It is designed for connections with remote locations where a small code footprint is required or the network bandwidth is limited.

The broker acts as a post office, MQTT doesn’t use the address of the intended recipient but uses the subject line called “Topic”, and anyone who wants a copy of that message will subscribe to that topic. Multiple clients can receive the message from a single broker (one to many capability). Similarly, multiple publishers can publish topics to a single subscriber (many to one).

Each client can both produce and receive data by both publishing and subscribing, i.e. the devices can publish sensor data and still be able to receive the configuration information or control commands. This helps in both sharing data, managing and controlling devices.

With MQTT broker architecture the devices and application becomes decoupled and more secure. MQTT might use Transport Layer Security (TLS) encryption with user name, password protected connections, and optional certifications that requires clients to provide a certificate file that matches with the server’s. The clients are unaware of each others IP address.

The broker can store the data in the form of retained messages so that new subscribers to the topic can get the last value straight away.

The main advantages of MQTT broker are:

- Eliminates vulnerable and insecure client connections
- Can easily scale from a single device to thousands
- Manages and tracks all client connection states, including security credentials and certificates
- Reduced network strain without compromising the security (cellular or satellite network)

Each connection to the broker can specify a quality of service measure. These are classified in increasing order of overhead:

<div id="bkmrk-at-most-once---the-m"><div><div><div>- At most once - the message is sent only once and the client and broker take no additional steps to acknowledge delivery (fire and forget).
- At least once - the message is re-tried by the sender multiple times until acknowledgement is received (acknowledged delivery).
- Exactly once - the sender and receiver engage in a two-level handshake to ensure only one copy of the message is received (assured delivery).

</div></div></div></div>### Using WCC Lite as MQTT Client

MQTT serves as an alternative for protocols conforming to IEC standards, for example, to send data to a cloud infrastructure that supports MQTT instead of IEC-60870-5-104.

<p class="callout success">WCC Lite supports MQTT messaging compatible with MQTT v3.1 standard (starting from version **v1.4.0**). Such messaging is possible via mapping of Redis and MQTT data therefore data can be transmitted from any protocol that is supported by WCC Lite.</p>

All standard functions, except for data encryption, are supported. Encrypted messages are not supported yet, therefore to ensure security a user would have to use a VPN service. A user can choose from three different Quality of Service levels, select if messages are to be retained, authenticate users and optionally send Last Will messages.

To configure WCC Lite a user can fill in the needed parameters in Excel configuration. These parameters are shown in the two tables below.

Table. MQTT parameters for Devices tab

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 1038.22px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 113px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 113px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 62px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35.4688px;"><td style="width: 130px; height: 35.4688px;">name</td><td style="width: 72px; height: 35.4688px;">string

</td><td style="width: 272px; height: 35.4688px;">User-friendly device name

</td><td style="width: 79px; height: 35.4688px;">Yes</td><td style="width: 109px; height: 35.4688px;">  
</td><td style="width: 69px; height: 35.4688px;">  
</td><td style="width: 69px; height: 35.4688px;">  
</td></tr><tr style="height: 57.8438px;"><td style="width: 130px; height: 57.8438px;">device\_alias</td><td style="width: 72px; height: 57.8438px;">string

</td><td style="width: 272px; height: 57.8438px;">Device alias to be used in the configuration

</td><td style="width: 79px; height: 57.8438px;">Yes</td><td style="width: 109px; height: 57.8438px;">  
</td><td style="width: 69px; height: 57.8438px;">  
</td><td style="width: 69px; height: 57.8438px;">  
</td></tr><tr style="height: 35.4688px;"><td style="width: 130px; height: 35.4688px;">enable</td><td style="width: 72px; height: 35.4688px;">boolean</td><td style="width: 272px; height: 35.4688px;">Enabling/disabling of a device

</td><td style="width: 79px; height: 35.4688px;">No</td><td style="width: 109px; height: 35.4688px;">0</td><td style="width: 69px; height: 35.4688px;">0</td><td style="width: 69px; height: 35.4688px;">1</td></tr><tr style="height: 35.4688px;"><td style="width: 130px; height: 35.4688px;">protocol</td><td style="width: 72px; height: 35.4688px;">string

</td><td style="width: 272px; height: 35.4688px;">Selection of protocol

</td><td style="width: 79px; height: 35.4688px;">Yes</td><td style="width: 109px; height: 35.4688px;">  
</td><td colspan="2" style="width: 138px; height: 35.4688px;">MQTT</td></tr><tr style="height: 57.7812px;"><td style="width: 130px; height: 57.7812px;">ip</td><td style="width: 72px; height: 57.7812px;">string

</td><td style="width: 272px; height: 57.7812px;">MQTT broker IP address/Domain name selection

</td><td style="width: 79px; height: 57.7812px;">Yes</td><td style="width: 109px; height: 57.7812px;">  
</td><td style="width: 69px; height: 57.7812px;">  
</td><td style="width: 69px; height: 57.7812px;">  
</td></tr><tr style="height: 35.4688px;"><td style="width: 130px; height: 35.4688px;">port</td><td style="width: 72px; height: 35.4688px;">integer</td><td style="width: 272px; height: 35.4688px;">MQTT broker port selection

</td><td style="width: 79px; height: 35.4688px;">No</td><td style="width: 109px; height: 35.4688px;">1883</td><td style="height: 35.4688px; width: 69px;">  
</td><td style="width: 69px; height: 35.4688px;">  
</td></tr><tr style="height: 80.2188px;"><td style="width: 130px; height: 80.2188px;">enable\_threshold</td><td style="width: 72px; height: 80.2188px;">boolean</td><td style="width: 272px; height: 80.2188px;">A parameter to determine if identical values should not be sent multiple times in a row.

</td><td style="width: 79px; height: 80.2188px;">No</td><td style="width: 109px; height: 80.2188px;">1</td><td style="width: 69px; height: 80.2188px;">0</td><td style="width: 69px; height: 80.2188px;">1</td></tr><tr style="height: 57.8438px;"><td style="width: 130px; height: 57.8438px;">mqtt\_qos</td><td style="width: 72px; height: 57.8438px;">integer</td><td style="width: 272px; height: 57.8438px;">MQTT Quality of Service for message as in standard

</td><td style="width: 79px; height: 57.8438px;">No</td><td style="width: 109px; height: 57.8438px;">0</td><td style="width: 69px; height: 57.8438px;">0</td><td style="width: 69px; height: 57.8438px;">2</td></tr><tr style="height: 57.8438px;"><td style="width: 130px; height: 57.8438px;">mqtt\_retain</td><td style="width: 72px; height: 57.8438px;">boolean</td><td style="width: 272px; height: 57.8438px;">Selecting if MQTT broker should retain last received messages

</td><td style="width: 79px; height: 57.8438px;">No</td><td style="width: 109px; height: 57.8438px;">0</td><td style="width: 69px; height: 57.8438px;">0</td><td style="width: 69px; height: 57.8438px;">1</td></tr><tr style="height: 35.4688px;"><td style="width: 130px; height: 35.4688px;">user</td><td style="width: 72px; height: 35.4688px;">string

</td><td style="width: 272px; height: 35.4688px;">MQTT user name

</td><td style="width: 79px; height: 35.4688px;">Yes</td><td style="width: 109px; height: 35.4688px;">  
</td><td style="height: 35.4688px; width: 69px;">  
</td><td style="width: 69px; height: 35.4688px;">  
</td></tr><tr style="height: 35.4688px;"><td style="width: 130px; height: 35.4688px;">password</td><td style="width: 72px; height: 35.4688px;">string

</td><td style="width: 272px; height: 35.4688px;">MQTT user password</td><td style="width: 79px; height: 35.4688px;">Yes</td><td style="width: 109px; height: 35.4688px;">  
</td><td style="width: 69px; height: 35.4688px;">  
</td><td style="width: 69px; height: 35.4688px;">  
</td></tr><tr><td style="width: 130px;">auth  
</td><td style="width: 72px;">string

</td><td style="width: 272px;">Selecting if TLS should be used</td><td style="width: 79px;">No  
</td><td style="width: 109px;">  
</td><td colspan="2" style="width: 138px;">tls  
</td></tr><tr><td style="width: 130px;">ca\_certificate  
</td><td style="width: 72px;">string

</td><td style="width: 272px;">Certificate authority file for TLS connection  
</td><td style="width: 79px;">Yes

(If auth=tls)

</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 130px;">client\_certificate</td><td style="width: 72px;">string

</td><td style="width: 272px;">Client certificate file for TLS connection</td><td style="width: 79px;">Yes

(If auth=tls)

</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr><td style="width: 130px;">client\_key</td><td style="width: 72px;">string

</td><td style="width: 272px;">Private key that corresponds to the client certificate for TLS connection  
</td><td style="width: 79px;">Yes

(If auth=tls)

</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr><tr style="height: 80.2188px;"><td style="width: 130px; height: 80.2188px;">use\_last\_will</td><td style="width: 72px; height: 80.2188px;">boolean</td><td style="width: 272px; height: 80.2188px;">Selecting if MQTT should use Last Will and Testament functionality

(Default: False)

</td><td style="width: 79px; height: 80.2188px;">No</td><td style="width: 109px; height: 80.2188px;">0</td><td style="width: 69px; height: 80.2188px;">0</td><td style="width: 69px; height: 80.2188px;">1</td></tr><tr style="height: 102.594px;"><td style="width: 130px; height: 102.594px;">last\_will\_topic</td><td style="width: 72px; height: 102.594px;">string

</td><td style="width: 272px; height: 102.594px;">Topic to which an MQTT message would be sent if the device abruptly disconnected message broker

</td><td style="width: 79px; height: 102.594px;">Yes

(If use\_last\_will=True)

</td><td style="width: 109px; height: 102.594px;">  
</td><td style="height: 102.594px; width: 69px;">  
</td><td style="width: 69px; height: 102.594px;">  
</td></tr><tr style="height: 80.2188px;"><td style="width: 130px; height: 80.2188px;">last\_will\_message</td><td style="width: 72px; height: 80.2188px;">string

</td><td style="width: 272px; height: 80.2188px;">Message to be sent over MQTT if the device abruptly disconnected message broker

</td><td style="width: 79px; height: 80.2188px;">No</td><td style="width: 109px; height: 80.2188px;">  
</td><td style="height: 80.2188px; width: 69px;">  
</td><td style="width: 69px; height: 80.2188px;">  
</td></tr><tr style="height: 57.8438px;"><td style="width: 130px; height: 57.8438px;">last\_will\_qos

</td><td style="width: 72px; height: 57.8438px;">integer</td><td style="width: 272px; height: 57.8438px;">MQTT Quality of Service selection as in standard

</td><td style="width: 79px; height: 57.8438px;">No</td><td style="width: 109px; height: 57.8438px;">0</td><td style="height: 57.8438px; width: 69px;">0</td><td style="width: 69px; height: 57.8438px;">2</td></tr><tr style="height: 80px;"><td style="width: 130px; height: 80px;">last\_will\_retain

</td><td style="width: 72px; height: 80px;">boolean</td><td style="width: 272px; height: 80px;">Selecting if MQTT broker should retain last will message

</td><td style="width: 79px; height: 80px;">No</td><td style="width: 109px; height: 80px;">0</td><td style="height: 80px; width: 69px;">0</td><td style="width: 69px; height: 80px;">1</td></tr><tr><td style="width: 130px;">client\_id

</td><td style="width: 72px;">string</td><td style="width: 272px;">User-friendly name for client id

</td><td style="width: 79px;">No</td><td style="width: 109px;">  
</td><td style="width: 69px;">  
</td><td style="width: 69px;">  
</td></tr></tbody></table>

To map the signal to send through MQTT client, it should have its device\_alias and signal\_alias mapped to source\_device\_alias and source\_signal\_alias respectively.

Table. MQTT parameters for Signals tab

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 130px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 72px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 272px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 29px;"><td style="width: 23.5185%; height: 29px;">signal\_name</td><td style="width: 11.6667%; height: 29px;">string</td><td style="width: 28.3334%; height: 29px;">User-friendly signal name

</td><td style="width: 12.4998%; height: 29px;">Yes</td><td style="width: 20.139%; height: 29px;"></td><td style="width: 3.20988%; height: 29px;">  
</td><td style="width: 30.1235%; height: 29px;"></td></tr><tr style="height: 29px;"><td style="width: 23.5185%; height: 29px;">device\_alias</td><td style="width: 11.6667%; height: 29px;">string</td><td style="width: 28.3334%; height: 29px;">Device alias from a Devices tab

</td><td style="width: 12.4998%; height: 29px;">Yes</td><td style="width: 20.139%; height: 29px;">  
</td><td style="width: 3.20988%; height: 29px;">  
</td><td style="width: 30.1235%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 23.5185%; height: 29px;">signal\_alias</td><td style="width: 11.6667%; height: 29px;">string</td><td style="width: 28.3334%; height: 29px;">Unique signal name to be used

</td><td style="width: 12.4998%; height: 29px;">Yes</td><td style="width: 20.139%; height: 29px;">  
</td><td style="width: 3.20988%; height: 29px;">  
</td><td style="width: 30.1235%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 23.5185%; height: 29px;">source\_device\_alias</td><td style="width: 11.6667%; height: 29px;">string</td><td style="width: 28.3334%; height: 29px;">device\_alias of a source device

</td><td style="width: 12.4998%; height: 29px;">Yes</td><td style="width: 20.139%; height: 29px;">  
</td><td style="width: 3.20988%; height: 29px;">  
</td><td style="width: 30.1235%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 23.5185%; height: 29px;">source\_signal\_alias</td><td style="width: 11.6667%; height: 29px;">string</td><td style="width: 28.3334%; height: 29px;">signal\_alias of a source signal

</td><td style="width: 12.4998%; height: 29px;">Yes</td><td style="width: 20.139%; height: 29px;">  
</td><td style="width: 3.20988%; height: 29px;">  
</td><td style="width: 30.1235%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 23.5185%; height: 29px;">enable</td><td style="width: 11.6667%; height: 29px;">boolean</td><td style="width: 28.3334%; height: 29px;">Enabling/disabling of an individual signal

</td><td style="width: 12.4998%; height: 29px;">No</td><td style="width: 20.139%; height: 29px;">1</td><td style="height: 29px; width: 3.20988%;">0</td><td style="width: 30.1235%; height: 29px;">1</td></tr><tr style="height: 35px;"><td style="width: 23.5185%; height: 35px;">log </td><td style="width: 11.6667%; height: 35px;">integer</td><td style="width: 28.3334%; height: 35px;">Allow signal to be logged. Log signal with 1 and no logging with 0.

</td><td style="width: 12.4998%; height: 35px;">No</td><td style="width: 20.139%; height: 35px;">0</td><td style="width: 3.20988%; height: 35px;"></td><td style="width: 30.1235%; height: 35px;"></td></tr><tr style="height: 29px;"><td style="width: 23.5185%; height: 29px;">topic</td><td style="width: 11.6667%; height: 29px;">string</td><td style="width: 28.3334%; height: 29px;">Topic name to override the value built by default

</td><td style="width: 12.4998%; height: 29px;">No</td><td style="width: 20.139%; height: 29px;">  
</td><td style="width: 3.20988%; height: 29px;">  
</td><td style="width: 30.1235%; height: 29px;">  
</td></tr></tbody></table>

### MQTT data format

The format of a MQTT message is a bit different than Redis messages. Redis messages are supported as CSV strings: value, timestamp, flags (where value can be float, integer or nan; timestamp - Unix timestamp in milliseconds; flags contain additional information about a measurement). MQTT messages are supported as value, timestamp, quality (where value can be float, integer or nan; timestamp - Unix timestamp in milliseconds; quality shows if a value is to be considered as valid). Quality parts of a string is always equal to 1 except for Redis messages containing invalid (IV), non-topic (NT) and/or overflow (OV) flags.

As mentioned, MQTT client acts as an adapter between Redis and MQTT, therefore data from topic in Redis is written to a topic in MQTT. Therefore mqtt-client has to know the mapping table before starting. This table is saved at /etc/elseta-mqtt.json. Every Redis topic name is constructed as tag/\[device\_alias\]/\[signal\_alias\]/\[direction\]. Prefix tag/ is always used before the rest of argument. `device_alias` and `signal_alias` represent columns in Excel configuration. Direction can have one of four possible values - rout, out, in, rin; all of which depend on the direction data is sent or acquired protocol-wise. The same Redis topic structure is preserved in MQTT by default making it easier to find matching signals, however, as no recalculation is done by MQTT and only PUBLISH messages are now supported, only Redis signals with in direction have their MQTT mappings.

A user can create and select his own topic name in Excel configuration, in topic column. As no recalculation is done by MQTT and only PUBLISH messages are now supported, only Redis signals with in direction have their MQTT mappings.

### Debugging a MQTT protocol

If configuration for MQTT is set up, handler for protocol will start automatically. If configuration is missing parameters or contains errors, protocol will not start. It is done intentionally to decrease unnecessary memory usage.

MQTT Client command line debugging options

`mqtt-client`

<div id="bkmrk-"><div><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg>  
</div></div>```
-h [ –help ] Display help information
-c [ –config ] Configuration file location (default - /etc/elseta-mqtt.conf) 
-V [ –version ] Show version
-d<debug level> [ –debug ] Set debugging level 
-r [ –redis ] Show REDIS output
-m [ –mqtt ] Show MQTT output
```

<p class="callout warning">If MQTT Client does not work properly (e.g. no communication between devices, data is corrupted, etc.), a user can launch a debug session from command line interface and find out why link is not functioning properly.</p>

<p class="callout info">To launch a debugging session, a user should stop `mqtt-client` process and run `mqtt-client` command with respective flags as was shown above.</p># 23 Data Export

## General

Various protocols are made to transmit data points as they are generated. This is enough for a lot of systems (e.g. SCADAs) that have their own databases and devices only have to buffer fairly recent messages in case of connection or transmission errors. However, there is frequently a need to save and keep the data in files, grouped in batches, and later transmit these batches to a remote server via HTTP(S) or FTP(S). For this purpose a dedicated protocol has been created and called **Data export.**

<p class="callout success">Data export functionality is available since firmware version v1.5.0, of WCC Lite.</p>

## Overview

Data export service gathers information from other protocols, puts it into files (optionally compressing them) after a timeout or when data buffers fill up; eventually periodically sending them to a server. HTTP(S) and FTP(S) servers with optional authentication are supported. A user can optionally choose between ISO8601 and UNIX timestamp time formats (the latter being the default value). More than one instance can set up, for instance, some of the information can be sent to an FTP server, while other could be transmitted to the HTTP server which is able to handle POST requests.

## Using WCC Lite for data export

To configure WCC Lite to use data export server a user can fill in the needed parameters in Excel configuration. These parameters are shown in two tables below. Default values are shown in a bold font.

*Data export (data-export) parameters for Devices tab table:*

<table border="1" id="bkmrk-parameter-descriptio-0" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 145px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 69.9625px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 258.975px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 78.9875px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 108.975px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 137.988px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 68.9875px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 145px; height: 35px;">name</td><td style="width: 69.9625px; height: 35px;">string</td><td style="width: 258.975px; height: 35px;">User-friendly device name

</td><td style="width: 78.9875px; height: 35px;">Yes</td><td style="width: 108.975px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 145px; height: 35px;">device\_alias</td><td style="width: 69.9625px; height: 35px;">string</td><td style="width: 258.975px; height: 35px;">Device alias to be used in configuration

</td><td style="width: 78.9875px; height: 35px;">Yes</td><td style="width: 108.975px; height: 35px;">  
</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 35px;"><td style="width: 145px; height: 35px;">enable</td><td style="width: 69.9625px; height: 35px;">boolean</td><td style="width: 258.975px; height: 35px;">Enabling/disabling of a device

</td><td style="width: 78.9875px; height: 35px;">No</td><td style="width: 108.975px; height: 35px;">1</td><td style="width: 68.9875px; height: 35px;">0</td><td style="width: 69px; height: 35px;">1</td></tr><tr style="height: 35px;"><td style="width: 145px; height: 35px;">protocol</td><td style="width: 69.9625px; height: 35px;">string</td><td style="width: 258.975px; height: 35px;">Selection of protocol

</td><td style="width: 78.9875px; height: 35px;">Yes</td><td style="width: 108.975px; height: 35px;">  
</td><td colspan="2" style="width: 137.988px; height: 35px;">Data Export</td></tr><tr style="height: 57px;"><td style="width: 145px; height: 57px;">timeout</td><td style="width: 69.9625px; height: 57px;">integer</td><td style="width: 258.975px; height: 57px;">Time frame during which transmission to remote server has to be completed (**in seconds**)

</td><td style="width: 78.9875px; height: 57px;">No</td><td style="width: 108.975px; height: 57px;">5</td><td style="height: 57px; width: 68.9875px;">  
</td><td style="width: 69px; height: 57px;">  
</td></tr><tr style="height: 25px;"><td style="width: 145px; height: 25px;">type</td><td style="width: 69.9625px; height: 25px;">string</td><td style="width: 258.975px; height: 25px;">Selection of file format

</td><td style="width: 78.9875px; height: 25px;">No</td><td style="width: 108.975px; height: 25px;">csv-simple</td><td colspan="2" style="height: 25px; width: 137.988px;">cvs-periodic

csv-simple,

json-simple,

json-samples

</td></tr><tr style="height: 10px;"><td style="width: 145px; height: 10px;">host</td><td style="width: 69.9625px; height: 10px;">string</td><td style="width: 258.975px; height: 10px;">A URL of remote server where files should be sent

</td><td style="width: 78.9875px; height: 10px;">Yes</td><td style="width: 108.975px; height: 10px;">  
</td><td style="width: 68.9875px; height: 10px;">  
</td><td style="width: 69px; height: 10px;">  
</td></tr><tr style="height: 35px;"><td style="width: 145px; height: 35px;">upload\_rate\_sec

</td><td style="width: 69.9625px; height: 35px;">integer</td><td style="width: 258.975px; height: 35px;">Frequency of generated file uploads (**in seconds)**

</td><td style="width: 78.9875px; height: 35px;">No</td><td style="width: 108.975px; height: 35px;">60</td><td style="width: 68.9875px; height: 35px;">  
</td><td style="width: 69px; height: 35px;">  
</td></tr><tr style="height: 57px;"><td style="width: 145px; height: 57px;">records\_buffer\_size

</td><td style="width: 69.9625px; height: 57px;">integer</td><td style="width: 258.975px; height: 57px;">A maximum amount of data change entries to hold before initiating logging mechanism

</td><td style="width: 78.9875px; height: 57px;">No</td><td style="width: 108.975px; height: 57px;">100</td><td style="width: 68.9875px; height: 57px;">  
</td><td style="width: 69px; height: 57px;">  
</td></tr><tr style="height: 57px;"><td style="width: 145px; height: 57px;">logging\_period\_sec

</td><td style="width: 69.9625px; height: 57px;">integer</td><td style="width: 258.975px; height: 57px;">Describes how frequently data buffer of records\_buffer\_size is saved to file

</td><td style="width: 78.9875px; height: 57px;">No</td><td style="width: 108.975px; height: 57px;"><div><div>10</div></div></td><td style="width: 68.9875px; height: 57px;">1</td><td style="width: 69px; height: 57px;"><div><div>3600</div></div></td></tr><tr style="height: 57px;"><td style="width: 145px; height: 57px;">log\_folder

</td><td style="width: 69.9625px; height: 57px;">string</td><td style="width: 258.975px; height: 57px;">A folder in WCC Lite file system to save generated file (**”/var/cache/data-export”**)

</td><td style="width: 78.9875px; height: 57px;">No</td><td style="width: 108.975px; height: 57px;">  
</td><td style="width: 68.9875px; height: 57px;">  
</td><td style="width: 69px; height: 57px;">  
</td></tr><tr style="height: 35px;"><td style="width: 145px; height: 35px;">timestamp

</td><td style="width: 69.9625px; height: 35px;">string</td><td style="width: 258.975px; height: 35px;">Selection of time format

</td><td style="width: 78.9875px; height: 35px;">No</td><td style="width: 108.975px; height: 35px;">unixtimestamp</td><td colspan="2" style="width: 137.988px; height: 35px;">unixtimestamp, iso8601</td></tr><tr style="height: 35px;"><td style="width: 145px; height: 35px;">compress

</td><td style="width: 69.9625px; height: 35px;">string</td><td style="width: 258.975px; height: 35px;">Selection of file compression mechanism

</td><td style="width: 78.9875px; height: 35px;">No</td><td style="width: 108.975px; height: 35px;">none</td><td colspan="2" style="width: 137.988px; height: 35px;">none, gz, tar.gz</td></tr><tr style="height: 35px;"><td style="width: 145px; height: 35px;">compress\_password

</td><td style="width: 69.9625px; height: 35px;">string</td><td style="width: 258.975px; height: 35px;">Enable feature of file password protection

</td><td style="width: 78.9875px; height: 35px;">No</td><td style="width: 108.975px; height: 35px;">  
</td><td colspan="2" style="width: 137.988px; height: 35px;">yes, true</td></tr><tr style="height: 57px;"><td style="width: 145px; height: 57px;">csv\_field\_separator

</td><td style="width: 69.9625px; height: 57px;">string</td><td style="width: 258.975px; height: 57px;">Columns separator in .csv file format

</td><td style="width: 78.9875px; height: 57px;">No</td><td style="width: 108.975px; height: 57px;">"," - (comma)</td><td colspan="2" style="width: 137.988px; height: 57px;">"," - (comma)

";" - (semicolon)

"." - (dot)

" " - whitespace)

"|" - (pipe)

</td></tr><tr style="height: 57px;"><td style="width: 145px; height: 57px;">csv\_decimal\_separator

</td><td style="width: 69.9625px; height: 57px;">string</td><td style="width: 258.975px; height: 57px;">Decimal separator in values

</td><td style="width: 78.9875px; height: 57px;">No</td><td style="width: 108.975px; height: 57px;">"." - (dot)</td><td colspan="2" style="width: 137.988px; height: 57px;">"." - (dot)

"," - (comma)

</td></tr></tbody></table>

<p class="callout info">Same symbols cannot be selected for both csv\_field\_separator and csv\_decimal\_separator. In such case both of them will be set to default values ­ ”.” and ”,” respectively.</p>

It is possible that data generation rate is going to be bigger than what data buffer can hold (controlled by *records\_buffer\_size* and *logging\_period\_sec*). To make sure that no data loss occurs there’s an additional data logging call made in case data buffer reaches a *records\_buffer\_size* value.

Signals to be sent are configured differently than signals for most other protocols. As data export service only transmits signals and does no data processing, usual signal logic is not used for them. That means that:

• Signals for data export service are not seen in the *Imported Signals* tab;  
• Signals for data export service are configured in different Excel sheet called DataExport

Parameters to be filled in the DataExport sheet are shown in a table below.

*Data export (data-export) parameters for DataExport tab*

<table border="1" id="bkmrk-parameter-type-descr" style="width: 726px; height: 484px;"><tbody><tr style="height: 62px;"><td class="align-center" rowspan="2" style="height: 102px; width: 136px;">**Parameter**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 69px;">**Type**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 269px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 79px;">**Required  
</td><td class="align-center" rowspan="2" style="height: 102px; width: 109px;">**Default value**

(when not specified)

</td><td class="align-center" colspan="2" style="height: 51px; width: 138px;">**Range**

</td></tr><tr style="height: 51px;"><td class="align-center" style="height: 51px; width: 69px;">Min

</td><td class="align-center" style="height: 51px; width: 69px;">Max

</td></tr><tr style="height: 35px;"><td style="width: 136px; height: 35px;">device\_alias

</td><td style="width: 69px; height: 35px;">string</td><td style="width: 269px; height: 35px;">Device alias to be used in configuration Yes

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 35px;"><td style="width: 136px; height: 35px;">device\_name

</td><td style="width: 69px; height: 35px;">string</td><td style="width: 269px; height: 35px;">User friendly device name as in Device sheet

</td><td style="width: 79px; height: 35px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 136px; height: 29px;">tag\_name</td><td style="width: 69px; height: 29px;">string</td><td style="width: 269px; height: 29px;">User friendly signal name

</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 136px; height: 29px;">source\_device\_alias</td><td style="width: 69px; height: 29px;">string</td><td style="width: 269px; height: 29px;">device\_alias of a source device

</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 136px; height: 29px;">source\_signal\_alias</td><td style="width: 69px; height: 29px;">string</td><td style="width: 269px; height: 29px;">source\_alias of a source signa

</td><td style="width: 79px; height: 29px;">Yes</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 136px; height: 10px;">enable</td><td style="width: 69px; height: 10px;">boolean</td><td style="width: 269px; height: 10px;">Enabling/disabling of a measurement to be transmitted and logged

</td><td style="width: 79px; height: 10px;">No</td><td style="width: 109px; height: 29px;">1</td><td style="width: 69px; height: 29px;">0</td><td style="width: 69px; height: 29px;">1</td></tr><tr style="height: 29px;"><td style="width: 136px; height: 29px;">attribute</td><td style="width: 69px; height: 29px;">string</td><td style="width: 269px; height: 29px;">Additional attribute to be attached to a signal

</td><td style="width: 79px; height: 29px;">No</td><td style="width: 109px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td><td style="width: 69px; height: 29px;">  
</td></tr></tbody></table>

## Debugging data export service

If configuration for Data export service is set up, handler for protocol will start automatically. If configuration is missing parameters or contains errors, protocol will not start. It is done intentionally to decrease unnecessary memory usage.

Data export (data-export) command-line debugging options

<p class="callout info">The below-described parameters for debugging are accessible over console (SSH).</p>

`-h [--help] Display help information`

`-c [--config] Configuration file location`

`-V [ –version ] Show version`

`-d<debug level> [ –debug ] Set debugging level`

`-R [ –readyfile] Ready notification file`

`-p [ –http ] Show HTTP messages`

`-r [ –redis ] Show Redis output`

If Data export service does not work properly (e.g. data is corrupted, etc.), a user can launch a debug session from command line interface and find out why it is not functioning properly. To launch a debugging session, a user should stop data-export processes and run data-export command with respective flags as in table above.

## Host URL format rules

Parameter host is highly configurable and might contain a considerable amount of information:

• *Protocol* - FTP or HTTP (encrypted and encrypted);

• *URL address* - both resolved and non-resolved;

• *Authentication* - pair of user and/or password;

• *Port* - useful when non-standard value is used;

• *Endpoint* - a place in server to which a call is made

The format for host parameter can be summarized as:

`[ h t t p ( s ) / f t p ( s ) ] : / / [ [ u s e r ] : [ p a s s w o r d ]@] [ URL ] [ : p o r t ] / [ e n d p o i n t ]`

Options are printed in square brackets. A protocol has to be selected, otherwise HTTP will be used as a default. User and password pair is optional, but if user: password pair is used, it should proceeded with @ sign.

HTTP and FTP use default or user assigned ports. By default HTTP uses port 80, while HTTPS uses port 443, FTP sends data over port 21, FTPS - over port 990. Make sure that these ports are open in firewall on both server and client side, otherwise data will not be sent successfully.

Finally, POST request (for HTTP) or upload (for FTP) can be made to a specific place (endpoint). This endpoint should be described after a URL and port (if used).

## Format of exported data

For a server to interpret data, a set of rules for a file format have to be established.

***Csv-simple*** format applies to all files by default and is used as in this example:

```
###DUID:3182121xx
#device name; tag name; value; quality; timestamp; atribute
inv1;Ia;236.9,1;1599137189963;Pa
```

Example of additional format *csv-periodic:*

```
###DUID:318212xxx
##DEVICE:inv1
#Time;Upv1;Upv2;Upv3;Upv4;Upv5;Upv6;Ipv1;Ipv2;Ipv3;Ipv4;Ipv5;Ipv6;Status;Error;Temp;cos;fac;Pac;Qac;Eac;E-Day;E-Total;Cycle Time
2020-09-02T15:45:00Z;462.3;462.3;370.2;370.2;371.2;371.2;1.40;1.43;1.35;1.47;1.21;1.26;512;0;26.3;1.000;50.00;3.217;-0.029;0.28;17.41;54284.53;5;
2020-09-02T15:40:00Z;462.3;462.3;370.2;370.2;371.2;371.2;1.40;1.43;1.35;1.47;1.21;1.26;;512;0;26.3;1.000;50.00;3.217;-0.029;0.28;17.41;54284.53;5;
##DEVICE:meter
#Time;Uab;Ubc;Uca;P;Q;S;F;eTOT;Cycle Time
2020-09-02T15:45:00Z;421.3;421.3;421.3;15000;100;15600;50;246894;5;
2020-09-02T15:40:00Z;421.3;421.3;421.3;15000;100;15600;50;246895;5;

```

Example of additional format json-simple*:*

```
{
  "metadata": {
    "duid": "318xxxxx",
    "name": "hostname",
    "loggingPeriod": "15min",
    "format": "json"
  },
  "data": [
    {
      "tag_name": "Ia",
      "device_name": "inv1",
      "attribute": "Pa",
      "last": { "value": 12.2, "timestamp": 1213123 },
      "min": { "value": 12, "timestamp": 1213123 },
      "max": { "value": 12, "timestamp": 1213123 },
      "avg": { "value": 12, "timestamp": 1213123 }
    },
    {
      "tagName": "Ib",
      "deviceName": "inv1",
      "attribute": "Pb",
      "last": { "value": -12.3, "timestamp": 1213123 },
      "min": { "value": 12, "timestamp": 1213123 },
      "max": { "value": 12, "timestamp": 1213123 },
      "avg": { "value": 12, "timestamp": 1213123 }
    },
  ]
}
```

Example of additional format json-sample*:*

```
{
    "metadata": {
      "duid": "318xxxxx",
      "name": "hostname",
      "loggingPeriod": "15min",
      "format": "json-samples"
    },
    "data": [
      {
        "tag_name": "Ia",
        "device_name": "inv1",
        "attribute": "Pa",
        "timestamp":{
            "first": 123123,
            "last": 123236
        },
        "first": { "value": 12.2, "timestamp": 1213123 },
        "last": { "value": 12.2, "timestamp": 1213123 },
        "min": { "value": -12, "timestamp": 1213123 },
        "max": { "value": 12, "timestamp": 1213123 },
        "avg": { "value": 12, "timestamp": 1213123 },
        "samplesCount": 2,
        "samples": [
            {"value": 12, "timestamp": 1213123, "quality": true},
            {"value": -12.3, "timestamp": 1213123, "quality": true}
        ]
      }
    ]
  }
```# 24 Certificates

Devices that send unencrypted data are susceptible to attacks which might cause deliberate damage to the user system. Therefore it is highly advised to use cryptography to secure the sensitive data. WCC Lite offers means to easily store certificates for their later usage.

Some protocols, namely IEC­60870-­5-­104 Slave, DNP v3.0 Slave and Master might be configured to send data over TCP/IP. For these protocols, secured connection over TCP/IP using TLS certificates can be made. For this purpose, certificate storage has been created and is available since firmware version 1.3.0.

To make storage secure, multiple steps have been taken:

- By default certificate storage is only accessible for root user and users with group level 15  
    permissions;
- By default certificates are not added to backup to avoid private key leakages; private keys  
    should never be revealed to public;
- By default certificates are deleted after system upgrade;
- Only basic information is shown on a web interface; certificates can be uploaded, deleted but  
    not downloaded

Certificates can be split into three parts ­ local (private) certificate, certificate from peer (usually called Certificate Authority (CA)) and private key. It has to be noted that all of these certificates sometimes can be found in one file, therefore ideally a user should have at least minimal understanding about formats in which certificates are stored.

Certificates should conform to the X509 standard. The difference between local certificate and certificate authority certificates is that only certificate authority generates certificates for others. Therefore Issuer and Subject fields are always the same for certificate authority certificate whereas they differ for local certificates. Both of these certificates are usually stored in a device to validate if incoming connections have valid certificates and are to be trusted. Both of the certificates have the public key which together with public key enable having encrypted connections.

The private key is a text file used initially to generate a Certificate Signing Request (CSR), and later to secure and verify connections using the certificate created per that request. It usually contains a unique hash made in a way that chances of guessing it by using brute force are technically infeasible. The private key should be closely guarded, since anyone with access to it use it in nefarious ways. If you lose your private key, or believe it was compromised in any way, it is recommended to re­key your certificate – reissue it with a new private key.

To make certificate upload more intuitive, certain restrictions are imposed. Only files with certain extensions (\*.crt, \*.pem, \*.der, \*.key) can be uploaded. Trying to upload other files will result in an error message. Certificate storage should be considered a folder with certain access restrictions, therefore file names should be unique for every file.

It should be noted that this chapter only reviews main certificates and suggest means to use them for Protocol Hub services. Certificates can also be used for other causes, e.g. to secure VPN connections. For the sake of simplicity, uploading certificates and their usage are explained in their respective chapters where applicable.

Interface for certificate storage

[![image-1704979328262.png](https://wiki.elseta.com/uploads/images/gallery/2024-01/scaled-1680-/image-1704979328262.png)](https://wiki.elseta.com/uploads/images/gallery/2024-01/image-1704979328262.png)

To get more details about how one could use TLS for Protocol Hub protocols please check section Excel configuration format.

To find out more about why certificates help keep device secure please check section [Cyber security](https://wiki.elseta.com/link/914#bkmrk-page-title) or check X.509 and RFC 5755 standard.# 25 Cyber security

WCC Lite is based on OpenWRT operating system. OpenWrt is described as a Linux distribution for embedded devices. WCC Lite has same functionality as Linux OS including user management.

Basic configuration on WCC Lite can be done using web based frontend. More advanced configuration is available over terminal interface. For secure web access, WCC Lite can be accessed via HTTPS (TLS) instead of the unencrypted HTTP protocol. You can use openssl utility to generate your own certificate authority and certificates to be used on web interface. Certificates can also be named or placed in whatever directory you wish by editing /etc/lighttpd/lighttpd.conf.

Terminal is accessible over Telnet or SSH. For security reasons we strongly recommend to use SSH. SSH, also known as Secure Socket Shell, is a network protocol that provides administrators with a secure way to access a remote computer. SSH also refers to the suite of utilities that implement the protocol. Secure shell provides strong authentication and secure encrypted data communications between two computers connecting over an insecure network such as the Internet. SSH is widely used by network administrators for managing systems and applications remotely, allowing them to log in to another computer over a network, execute commands and move files from one computer to another.

### User rights

Depending on the user name, different rights are defined: admin is generally entitled to make changes while user does not have any editing permissions, the relevant buttons are disabled. User can be assigned to one of fifteen user groups that can access different amounts of device parameters. Highest (fifteenth) permission level grants the same permission as root user has. User group rights can be edited to give more rights or restrictions, except for highest (15th) level.

#### User management and rights authentication

WCC Lite provides different authentication mechanisms:

- Authentication via locally stored credentials. In this scenario all users, passwords and  
    permissions are encrypted and stored in internal WCC Lite storage.
- Authentication via external RADIUS Server. In this scenario all users, passwords and  
    permissions (profiles) are defined in remote RADIUS Server. Login into WCC Lite is available  
    only if RADIUS Server will grant authentication and will provide user profile with user rights on  
    that device (more detailed description below). This also means that a password for such user  
    cannot be changed remotely.
- Authentication via external RADIUS Server with fallback option. In this scenario users will be  
    authenticated via RADIUS server. If server fails to respond (configured timeout is passed) WCC  
    will use locally stored credentials. Fallback options are selected with PAM configuration.

By default only authentication via locally stored credentials is allowed. For authentication via external RADIUS server a user should at first enable RADIUS process and configure at least one server.

#### Locally stored credentials management

Device has predefined default users like *root* and *user.[![image-1689334357068.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689334357068.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689334357068.png)*

*Screen containing all users*

[![image-1689334395442.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689334395442.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689334395442.png)

Screen for new user configuration

**root** user has full permission set to connect to WCC Lite over web interface and SSH or Telnet. This user is default user on WCC Lite and cannot be deleted. However, it is highly advised to change the default password to a different one less susceptible for attacks.

**user** is limited user on system and can’t get root rights. A default password for access via command­ line interface and web interface is ***wcclite***. It is advised to change this password to increase a level of security.

System allows customer to set up even more users with well known commands like *adduser, passwd* and *userdel.* More users can also be added or edited via web interface as shown in the figures above. User should enter user name, user groups for which the user should belong (the group must be preconfigured first), SSH access permision as well as password. When editing user settings, only *User Group* and *SSH Access* permission can be changed. To change user password, *Change Password* button should be pressed as seen in figure above to lead user to a screen seen in the figure below.

[![image-1689334539352.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689334539352.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689334539352.png)

Changing user password

A user needs to be assigned to **root** group for admin rights and have root access

<p class="callout info">It should be noted that assigning user to a root group only gives complete authority over web interface. Permissions for a command­ line interface should be given by a root user via command­ line interface.</p>

Following commands may be used in command line interface for user control:

**adduser** -­ create a new user or update default new user information

When invoked without the **­-D** option, the *adduser* command creates a new user account using the values specified on the command line plus the default values from the system. Depending on command line options, the useradd command will update system files and may also create the new user’s home directory and copy initial files.

**passwd** -­ change user password

The *passwd* command changes passwords for user accounts. A normal user may only change the password for his/her own account, while the superuser may change the password for any account. *passwd* also changes the account or associated password validity period.

**deluser** -­ delete a user account and related files  
The *deluser* command modifies the system account files, deleting all entries that refer to the user name LOGIN. The named user must exist.

<p class="callout info">If a user intends to use newly created user account via both command­line interface and web interface he should create and delete users via web interface and not using adduser and deluser commands as they don’t create uci entries.</p>

For more information about controlling users via command line interface one should refer to Linux documentation.

#### Authentication via external service

WCC Lite support external authentication via RADIUS service. Remote Authentication Dial­In User Service (RADIUS) is a networking protocol that provides centralized Authentication, Authorization, and Accounting (AAA or Triple A) management for users who connect and use a network service. RADIUS is a client/server protocol that runs in the application layer, and can use either TCP or UDP as transport. Network access servers, the gateways that control access to a network, usually contain a RADIUS client component that communicates with the RADIUS server. RADIUS is often the back­end of choice for 802.1X authentication as well. The RADIUS server is usually a background process running on a UNIX or Microsoft Windows server. In WCC Lite RADIUS Client is implemented since WCC Lite software version v1.2.4. The user sends a request to a WCC Lite to gain access to get access using access credentials posted in an HTTP/HTTPS WCCLite web login form

This request includes access credentials, typically in the form of username and password. Additionally, the request may contain other information which the Device knows about the user, such as its network address or information regarding the user’s physical point of attachment to the device. The RADIUS server checks that the information is correct using authentication schemes such as PAP, CHAP or EAP. The user’s proof of identification is verified, along with, optionally, other information related to the request, such as the user’s network address, account status, and specific network service access privileges. Historically, RADIUS servers checked the user’s information against a locally stored flat file database. Modern RADIUS servers can do this, or can refer to external sources—commonly SQL, Kerberos, LDAP, or Active Directory servers—to verify the user’s credentials. The RADIUS server then returns one of two responses to the WCC Lite:

1. **Access-Reject** -­ The user is unconditionally denied access to all requested resources. Reasons may include failure to provide proof of identification or an unknown or inactive user account.
2. **Access-Accept** ­- The user is granted access. Once the user is authenticated, the RADIUS server will periodically check if the user is authorized to use the service requested. A given user may be allowed to get admin rights or user rights depending on permissions set on RADIUS Server. Again, this information may be stored locally on the RADIUS server, or may be looked up in an external source such as LDAP or Active Directory.

To use this mechanism a RADIUS server must be configured. The parameter Radius Authentication must be Enabled on WCC Lite.

As of firmware version 1.2.13, the RADIUS service is disabled by default. The service can be enabled at System­ --&gt;Startup.

If the RADIUS authentication is enabled, WCC Lite uses the RADIUS server IP address and the RADIUS shared secret key for communication with External RADIUS Server. After entering the login credentials and login attempt, WCC Lite sends these credentials to the RADIUS server for authentication. If the RADIUS server is available, it compares the login credentials:

- If the comparison is successful, the RADIUS server returns the specific user role and Access-Accept;
- If the login credentials are invalid, Radius Server returns Access­-Reject and the logon fails.
- If the RADIUS server is not available and fallback option is disabled login into WCC Lite will  
    be imposible. If RADIUS server is not available and timeout occurs, login will be attempted via  
    local login credentials.

*<span style="text-decoration: underline;">Enabled:</span>* Enables or disables this server.  
*<span style="text-decoration: underline;">Hostname/IP:</span>* Hostname or IP address of RADIUS server.  
*<span style="text-decoration: underline;">Timeout:</span>* Timeout in seconds to wait for server response.  
*<span style="text-decoration: underline;">Shared</span>* secret: Key shared between RADIUS server and RADIUS client.  
*<span style="text-decoration: underline;">Add:</span>* Adds auxiliary (backup) server.

#### Audit Log

WCC Lite OS with version &gt;1.2.0 has integrated Audit logging for important events such as:

- Login/logout.
- Wrong password attempts to login into system.
- Device boot event, when system was started.
- Device reboot/halt event.
- Configuration changes.
- Firmware changes.
- Date and time changes in system (excluding automatic system time updates over NTP or IEC 60870­5­10x protocol)

<p class="callout info">Enabling external system log server setup in System properties ­--&gt; Logging is recommended. System stores logs in RAM memory by default due to limited flash storage. Rebooting or powering off the device will result in loss of log history.</p>

#### Secure your device’s access

There are some possibilities to grant access to the device (or to any PC/Server):

1. ask for nothing: anybody who can establish a connection gets access
2. ask for username and password on an unsecured connection (e.g. telnet)
3. ask for username and password on an encrypted connection (e.g. SSH) (e.g. by following  
    firstlogin)
4. ask for username and merely a signature instead of a password (e.g. SSH with  
    signature.authentication)

If you ask for username/password, an attacker has to guess the combination. If you use an unencrypted connection, he could eavesdrop on you and obtain them.

If you use an encrypted connection, any eavesdropper would have to decrypt the packets first. This is always possible. How long it takes to decrypt the content, depends on the algorithm and key length you used.

Also, as long as an attacker has network access to the console, he can always run a brute­force attack to find out username and password. He does not have to do that himself: he can let his computer(s) do the guessing. To render this option improbable or even impossible you can:

- not offer access from the Internet at all, or restrict it to certain IP addresses or IP address ranges 
    - by letting the SSH server dropbear and the web­Server lighttpd not listen on theexternal/WAN port
    - by blocking incoming connections to those ports (TCP 22, 80 and 443 by default) in yourfirewall
- make it more difficult to guess: 
    - don’t use the username root
    - don’t use a weak password with 8 or less characters
    - don’t let the SSH server dropbear listen on the default port (22)
- use the combination of: 
    - username different than root
    - tell dropbear to listen on a random port (should be &gt;1024): **System --&gt; Administration --&gt;Dropbear Instance --&gt; Port**
    - public key authentication. Your public keys can be specified in **Administration --&gt; System &gt; SSH­keys**. An older guide to DropBear SSH public key authentication has detailed information on generating SSH keypairs which include the public key(s) you should upload to your configuration.

### Groups rights

If user is logged on via external server, its authentication level is acquired. As no direct mapping to existing users is used, authentication levels are a way to grant proper permissions for external users. WCC Lite uses a CISCO­ like authentication system, meaning that there are fifteen different permission set level settings, of which the first 14 can be configured to enable or disable View and Edit permissions.

#### SSH Access

SSH Access of WCC Lite is made by Dropbear software package. To extend the basic functionality, Pluggable Authentification Module (PAM) for RADIUS is used. This enables user to add his own authentification modules as long as they are properly configured.

Fifteen levels of authorization are mapped for SSH access, meaning that user should be able to access SSH with credentials used to log into web interface. However, one should note that permissions in command line interface are not configurable via web interface. This means that first fourteen levels are restricted to basic permissions made my creating group by default. Highest level  
user has all the permissions root user has.

If a user intends to change permissions for user groups, it should be done via command line interfaces. It is only advised for advanced users.

#### Web interface permissions

Fifteen levels of authorization permission are mapped for web interface access, meaning that user should be able to access web interface with credentials used to log into command line interface. User assigned to a highest authorization level group is able to access every possible screen therefore this groups cannot be edited.

Figure below shows a screen containing already existing groups in a device. Pressing *Add New Group...* guides user to an *Edit group* screen, with *Edit* and *Delete* buttons respectively user can Edit and Delete configuration of a given user group.

[![image-1689335982520.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689335982520.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689335982520.png)

Screen showing existing user groups[![image-1689336022397.png](https://wiki.elseta.com/uploads/images/gallery/2023-07/scaled-1680-/image-1689336022397.png)](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689336022397.png)

Screen for user group editing

Edit group screen for an individual group can be seen in Figure above. Group name doesn’t have any specific purpose for RADIUS, but it enables naming groups with words most meaningful for a given context. Access level values can only be integers between 1 and 14, other values will result in an error messages; only unconfigured levels are shown in a dropdown list when configuring. Other fields are dedicated for an individual menu configuration. To add more first level menus user should select from a dropdown list at the bottom named *–Additional Field–* and press Add.

Permissions for web interface are split into to parts: *View* and *Edit.*

*View* permissions can be assigned to second level menus meaning that only allowed subtabs are shown for a user. Selecting *View* checkbox show more parameters containing all the subtabs (submenus). If a user can access a given screen, it means all of the actions in that screen are available to be executed. Therefore, if a user with a lot of restrictions shouldn’t, for example, import Excel configuration to WCC Lite, a tab containing this action (*Protocol Hub­&gt;Configuration*) should be disabled in his groups' configuration.

*Edit* permissions can be assigned to first level menus meaning that if this permission is given, every configuration in the first level menu can be saved and applied succesfully

### Conformance to IEC 62351 standard

IEC 62351 is a standard developed by WG15 of IEC TC57. This is developed for handling the security of TC 57 series of protocols including IEC 60870­5 series, IEC 60870­6 series, IEC 61850 series, IEC 61970 series and IEC 61968 series. The different security objectives include authentication of data transfer through digital signatures, ensuring only authenticated access, prevention of  
eavesdropping, prevention of playback and spoofing, and intrusion detection.

Conformance to IEC 62351 standard of WCC Lite devices is described in a table below.

Conformance to IEC 62351 standard

<table border="1" id="bkmrk-standard-description" style="border-collapse: collapse; width: 100%; height: 723px;"><tbody><tr style="height: 29px;"><td style="width: 20%; height: 29px;">**Standard**</td><td style="width: 20%; height: 29px;">**Description** </td><td style="width: 35.679%; height: 29px;">**Topic** </td><td style="width: 14.9383%; height: 29px;">**Implemented** </td><td style="width: 9.38272%; height: 29px;">**Version**</td></tr><tr style="height: 29px;"><td rowspan="3" style="width: 20%; height: 87px;">IEC 62351­-3

</td><td rowspan="3" style="width: 20%; height: 87px;">Security for any profiles including TCP/IP</td><td style="width: 35.679%; height: 29px;">TLS Encryption</td><td style="width: 14.9383%; height: 29px;">Yes</td><td style="width: 9.38272%; height: 29px;">&gt;=1.3</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">Node Authentication by means of X.509 certificates</td><td style="width: 14.9383%; height: 29px;">Yes</td><td style="width: 9.38272%; height: 29px;">&gt;=1.3</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">Message Authentication</td><td style="width: 14.9383%; height: 29px;">Yes</td><td style="width: 9.38272%; height: 29px;">&gt;=1.3</td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">IEC 62351­-4</td><td rowspan="2" style="width: 20%; height: 58px;">Security for any  
profiles including  
MMS</td><td style="width: 35.679%; height: 29px;">Authentication for MMS</td><td style="width: 14.9383%; height: 29px;">Yes</td><td style="width: 9.38272%; height: 29px;">&gt;=1.5</td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">  
</td><td style="width: 35.679%; height: 29px;">TLS (RFC 2246)is inserted between RFC 1006 &amp; RFC 793 to provide transport layer  
security</td><td style="width: 14.9383%; height: 29px;">Yes</td><td style="width: 9.38272%; height: 29px;">&gt;=1.5</td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">IEC 62351­-5</td><td style="width: 20%; height: 29px;">Security for any  
profiles including  
IEC 60870­5</td><td style="width: 35.679%; height: 29px;">TLS for TCP/IP profiles and encryption for serial profiles</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td rowspan="2" style="width: 20%; height: 58px;">IEC 62351­-6</td><td rowspan="2" style="width: 20%; height: 58px;">Security for IEC  
61850 profiles</td><td style="width: 35.679%; height: 29px;">VLAN use is made as mandatory for GOOSE</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">RFC 2030 to be used for SNTP</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">IEC 62351­-7</td><td style="width: 20%; height: 29px;">Security through  
network and system  
management</td><td style="width: 35.679%; height: 29px;">Defines Management Information Base (MIBs) that are specific for the power industry, to handle network and system  
management through SNMP based methods</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">IEC 62351­-8</td><td style="width: 20%; height: 29px;">Role­-based access control</td><td style="width: 35.679%; height: 29px;">Covers the access control of users and automated agents to data objects in power systems by means of role­based access  
control (RBAC)</td><td style="width: 14.9383%; height: 29px;">Yes</td><td style="width: 9.38272%; height: 29px;">&gt;=1.2.6</td></tr><tr style="height: 29px;"><td rowspan="4" style="width: 20%; height: 116px;">IEC 62351­-9</td><td rowspan="4" style="width: 20%; height: 116px;">Key  
Management</td><td style="width: 35.679%; height: 29px;">Describes the correct and safe usage of safety-­critical parameters, e.g. passwords,  
encryption keys.</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">Covers the whole life cycle of cryptographic information (enrolment, creation,  
distribution, installation, usage, storage and removal)</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">Methods for algorithms using asymmetric cryptography</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">A secure distribution mechanism based on GDOI and the IKEv2 protocol is  
presented for the usage of symmetric keys, e.g. session keys</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 63px;"><td rowspan="4" style="width: 20%; height: 155px;">IEC 62351­-10</td><td rowspan="4" style="width: 20%; height: 155px;">Security Architecture</td><td style="width: 35.679%; height: 63px;">Explanation of security architectures for the entire IT infrastructure</td><td style="width: 14.9383%; height: 63px;">No</td><td style="width: 9.38272%; height: 63px;">  
</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">Identifying critical points of the communication architecture, e.g. substation control center, substation automation</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">Appropriate mechanisms security requirements, e.g. data encryption, user authentication</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 34px;"><td style="width: 35.679%; height: 34px;">Applicability of well­proven standards from the IT domain, e.g. VPN tunnel, secure FTP,  
HTTPS</td><td style="width: 14.9383%; height: 34px;">No</td><td style="width: 9.38272%; height: 34px;">  
</td></tr><tr style="height: 29px;"><td rowspan="4" style="width: 20%; height: 29px;">IEC 62351­-11</td><td rowspan="4" style="width: 20%; height: 29px;">Security for XML Files</td><td style="width: 35.679%; height: 29px;">Embedding of the original XML content into an XML container</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 46px;"><td style="width: 35.679%; height: 46px;">Date of issue and access control for XML data</td><td style="width: 14.9383%; height: 46px;">No</td><td style="width: 9.38272%; height: 46px;">  
</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">X.509 signature for authenticity of XML data</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 35.679%; height: 29px;">Optional data encryption</td><td style="width: 14.9383%; height: 29px;">No</td><td style="width: 9.38272%; height: 29px;">  
</td></tr></tbody></table># 26 SMS Receiver



# 26.1 Introduction

SMS receiver is a service responsible for command execution that were received via text message. The service is available on WCC Lite with modem. To use this service a working SIM card is also required. This chapter will describe command types, configuration for WCC Lite as well as an example of said configuration.

# 26.2 SMS Receiver

There are two types of command signals used in SMS Receiver:

1. System: 
    - reboot wcc/reboot modem – when sending a message with text *reboot, the* device starts rebooting and after a successful reload sends back a message to the sender with text REBOOT OK.
    - switch sim – after sending a message with text *switch-sim, the* device should switch sim and send an SMS from the new sim card with the interface name and IP address.
    - show ip – the sender can request the IP address of the receiving device.
2. Signal: 
    - publish – executes *publish* to a certain tag after sending a text message, which will be indicated in the configuration field tag\_job\_todo. For example, if tag\_job\_todo is led=%f, after sending a text message *led=1*, a publish will happen to a tag that's linked with this signal.

##### Configuration

Devices sheet:

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 312.162px;"><tbody><tr style="height: 50.075px;"><td rowspan="2" style="width: 12.2343%; height: 80.1625px;">**Parameter**  
  
</td><td rowspan="2" style="width: 9.51557%; height: 80.1625px;">**Type**  
  
</td><td rowspan="2" style="width: 30.4004%; height: 80.1625px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="width: 11.9871%; height: 80.1625px;">**Required**  
  
</td><td class="align-center" rowspan="2" style="width: 14.2116%; height: 80.1625px;">**Default Value**

(when not specified)

</td><td class="align-center" colspan="2" style="width: 21.5027%; height: 50.075px;">**Range**  
  
</td></tr><tr style="height: 30.0875px;"><td class="align-center" style="width: 10.7514%; height: 30.0875px;">Min</td><td class="align-center" style="width: 10.7514%; height: 30.0875px;">Max</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">name</td><td style="width: 9.51557%; height: 46.4px;">string</td><td style="width: 30.4004%; height: 46.4px;">User-friendly name for a device</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">description</td><td style="width: 9.51557%; height: 46.4px;">sting</td><td style="width: 30.4004%; height: 46.4px;">Description of a device</td><td style="width: 11.9871%; height: 46.4px;">No</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">device\_alias</td><td style="width: 9.51557%; height: 46.4px;">string</td><td style="width: 30.4004%; height: 46.4px;">Alphanumeric string to identify a device</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">enable</td><td style="width: 9.51557%; height: 46.4px;">boolean</td><td style="width: 30.4004%; height: 46.4px;">Enabling/disabling of a device</td><td style="width: 11.9871%; height: 46.4px;">No</td><td style="width: 14.2116%; height: 46.4px;">1</td><td style="width: 10.7514%; height: 46.4px;">0</td><td style="width: 10.7514%; height: 46.4px;">1</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">protocol</td><td style="width: 9.51557%; height: 46.4px;">string</td><td style="width: 30.4004%;">Protocol to be used

</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td colspan="2" style="width: 21.574%; height: 49.5938px;">sms receiver</td></tr><tr><td style="width: 12.2343%;">host</td><td style="width: 9.51557%;">string</td><td style="width: 30.4004%;">Telephone number from which to receive SMS

</td><td style="width: 11.9871%;">Yes</td><td style="width: 14.2116%;">  
</td><td colspan="2">\[all, +37061111111\] (case-sensitive, separated by command or space)</td></tr></tbody></table>

When the host is set to all, only the job\_todo=signal type is allowed.

Signals sheet:

<table border="1" id="bkmrk-parameter-type-descr-0" style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px; width: 100%; height: 312.162px;"><tbody><tr style="height: 50.075px;"><td rowspan="2" style="width: 12.2343%; height: 80.1625px;">**Parameter**  
  
</td><td rowspan="2" style="width: 9.88631%; height: 80.1625px;">**Type**  
  
</td><td rowspan="2" style="width: 30.0297%; height: 80.1625px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="width: 11.9871%; height: 80.1625px;">**Required**  
  
</td><td class="align-center" rowspan="2" style="width: 14.2116%; height: 80.1625px;">**Default Value**

(when not specified)

</td><td class="align-center" colspan="2" style="width: 21.5027%; height: 50.075px;">**Range**  
  
</td></tr><tr style="height: 30.0875px;"><td class="align-center" style="width: 10.7514%; height: 30.0875px;">Min</td><td class="align-center" style="width: 10.7514%; height: 30.0875px;">Max</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">signal\_name</td><td style="width: 9.88631%; height: 46.4px;">string</td><td style="width: 30.0297%; height: 46.4px;">User-friendly signal name</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">device\_alias</td><td style="width: 9.88631%; height: 46.4px;">string </td><td style="width: 30.0297%; height: 46.4px;">Alphanumeric string to identify a device</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">signal\_alias</td><td style="width: 9.88631%; height: 46.4px;">string</td><td style="width: 30.0297%; height: 46.4px;">Unique alphanumeric name of the signal to be Yes used</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">enable</td><td style="width: 9.88631%; height: 46.4px;">boolean</td><td style="width: 30.0297%; height: 46.4px;">Enabling/disabling of an individual signal</td><td style="width: 11.9871%; height: 46.4px;">No</td><td style="width: 14.2116%; height: 46.4px;">1</td><td style="width: 10.7514%; height: 46.4px;">0</td><td style="width: 10.7514%; height: 46.4px;">1</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">job\_todo</td><td data-colwidth="320" style="width: 9.88631%;">string

</td><td style="width: 30.0297%;">Choose command type</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td colspan="2" style="width: 21.5027%; height: 49.5938px;">\[SIGNAL, SYSTEM\]

(case-insensitive)

</td></tr><tr><td style="width: 12.2343%;">tag\_job\_todo</td><td style="width: 9.88631%;">string</td><td style="width: 30.0297%;">which command to execute

(if signal, then configure the SMS)

</td><td style="width: 11.9871%;">  
</td><td style="width: 14.2116%;">  
</td><td colspan="2" style="width: 21.5027%;">\[REBOOT WCC, REBOOT MODEM, SWITCH SIM, SHOW IP, &lt;CUSTOM&gt;%F\] (case-insensitive)</td></tr></tbody></table>

When configuring the publish signal, the command that will be received needs to be specified. Instead of %f a number will be sent to the receiver as a text message. For example, if the configuration specifies that tag\_job\_todo is led=%f, then after sending a message to a device led=50, the signal will publish a number 50 to an indicated tag.

##### Configuration example

The following example will show how to create a configuration for WCC Lite which would allow rebooting a device or modem, changing the active SIM card, showing the IP address, and turning on the red status LED, using SMS receiver and internal data. For this 2 working SIM cards and WCC Lite with modem will be needed.

The devices sheet should look like this:

[![image-1686311153046.png](https://wiki.elseta.com/uploads/images/gallery/2023-06/scaled-1680-/image-1686311153046.png)](https://wiki.elseta.com/uploads/images/gallery/2023-06/image-1686311153046.png)

For the device *SMS receiver admin* host should be changed to a phone number from which commands will be received, because for this device signals will be system type. For the device SMS receiver host can be either all or the same phone number.

Signals sheet:

[![image-1686050114765.png](https://wiki.elseta.com/uploads/images/gallery/2023-06/scaled-1680-/image-1686050114765.png)](https://wiki.elseta.com/uploads/images/gallery/2023-06/image-1686050114765.png)

Signal LED red fault is linked with signal sms-led as a source. This means that after sending an SMS message to a device with text led=1, red status led will turn on. The rest of the signals are system type so after sending an SMS message a certain event will happen. For example, after sending a message with the text reboot-wcc, the device should start rebooting and after the process is done it will send back a message "REBOOT WCCLITE OK". The same thing would happen after rebooting the modem. With system signals it is also possible to switch between SIM cards or request IP address via text message.

Configuration --&gt; [Download](https://wiki.elseta.com/attachments/106)

<p class="callout info">Note: SMS Receiver can only accept messages that contain less than 160 characters.</p>