| ##### System | |
| Processor | ARM CPU (AR9331, 400MHz) |
| Memory | 16 MB Flash/64 MB DDR2 RAM |
| Wireless | 802.11 b/g/n |
| I/O | 1x Binary input (hardware version >=1.4) 1x Relay output |
| Additional storage SD card (2GB by default) | SD card (2GB by default) |
| Ethernet 10/100 BaseT RJ45 connector up to 2 independent ports | 10/100 BaseT RJ45 connector up to 2 independent ports |
| Serial ports | 1x RS485 1x RS485 / RS232 (switchable) |
| Time synchronization | NTP client + server, IEC 608705101, IEC 608705104 |
| GSM | 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 |
| ##### Power requirements | |
| Power supply | 12 - 24 VDC |
| Power consumption | < 6W |
| Dimensions | 101 (H) x 22.5 (W) x 119 (L), mm |
| Mounting | Wall mount, Din rail |
| ##### Environmental | |
| Operating temperature | 40°C to +85°C |
| Warranty | 2 year |
| ##### Software | |
| Compatibility with HMI (Human Machine Interface) | Compatible with cloud based SCADA system -CloudIndustries.eu |
| Routing | • 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 |
| Database | • File based database • Data buffering in case of network outage |
| Data security | • 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 |
| Device maintenance | 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 devicebased alarms such as communication errors, etc. |
| Supported protocols | • Modbus master / slave (RTU / ASCII / TCP) • MBus master (Serial / TCP) • IEC 608705 101 master / slave • IEC 608705 103 master • IEC 608705 104 master / slave • IEC 6205631 master • IEC 6205621 (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) |
| Supported devices | • 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 |
| Network features | • IPsec • OpenVPN • xl2tp • Firewall • Routing • RADIUS • SNMP • ser2net • API • NTP synchronization |
| Extra features | • Software update • Remote configuration via CloudIndustries.eu administration • Device fault notifications • Internal web page for configuration and diagnostics |
| Pressing time | Description | Indication |
| Short Press | System reboot | Red STATUS LED starts blinking |
| Long press (>3s) | Reset to factory settings | Red STATUS LED turns on |
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.
# 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. [](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. [](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.Note: Be careful when removing or inserting DUAL-SIM holder, as SIM cards can fall out.
Note: WCC Lite will automatically detect a SIM card insertion or removal.
# 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. [](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669194105015.png) Figure 7: WCC Lite ports 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.Note: Double-check if A and B wires are not mixed up.
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. [](https://wiki.elseta.com/uploads/images/gallery/2022-03/image-1647614290547.png) Figure 8: Typical WCC Lite RS-485 connection diagram [](https://wiki.elseta.com/uploads/images/gallery/2022-03/image-1647614310588.png) Figure 9: Typical WCC Lite RS-232 connection diagram # 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. [](https://wiki.elseta.com/uploads/images/gallery/2022-11/image-1669194156568.png) Figure 10: Signal relay connector 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. 1x105 operations; - resistive load, 30VDC / 2A - 60W min. 1x104 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).| Input voltage | 12-48 VDC (accepts 10-60V) |
| Protection | ±60 VDC reverse polarity protection Isolated from main logic |
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.
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. [](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. [](https://wiki.elseta.com/uploads/images/gallery/2023-09/image-1694092887560.png)Figure 2. Wi-Fi antenna connector (hardware version newer than **1.3**)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.
Make sure the signal level is over -80dBm to have a stable connection to the network.
# 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.| Value | Representation |
| 0 | OFF |
| 1 | ON |
| Value | Representation |
| 00 | INDETERMINATE |
| 01 | OFF |
| 10 | ON |
| 11 | ERROR |
| Path | Description |
| /api/version | Version of the API |
| /api/actions | List of available points |
| /api/syncVersion | Version of the sync service |
| /api/sync | hub configuration sync (name=”file”)\* |
| /api/syslog | Prints out the syslog |
| /api/systemInfo | General system info |
| /api/gsmInfo | GSM modem information |
| /api/devices | List of configured devices |
| /api/device/info | Device information (name=”device\_alias”)\*\* |
| /api/device/tags | List of tags on particular device (name=”device\_alias”)\*\* |
| /api/device/tag/value | Tag value (name=”device\_alias”, name=”signal\_alias”)\*\* |
| /api/tags | List of configured tags |
| /api/sysupgrade | Firmware upgrade (name=”file”)\* |
SMS sender functionality is available since firmware version v1.5.4, of WCC Lite.
### 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:*| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of the device | No | |||
| device\_alias | string | Device alias to be used in configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | **SMS sender** | ||
| host | array | List of phone numbers to send SMS to, separated by space. | Yes | |||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique signal name to be used | Yes | |||
| source\_device\_alias | string | device\_alias of the source device | No | |||
| source\_signal\_alias | string | source\_alias of the source signal | No | |||
| enable | boolean | Enabling/disabling of a signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | 0 | |
| job\_todo | string | Specific SMS sender tag type | Yes | send-sms, device-control, device-status | ||
| tag\_job\_todo | string | SMS sender tag for **send-sms**: *text message* | Yes | |||
| trigger | string | Trigger expression for the SMS to be sent | No (Only for send\_sms) | value!=0 | ||
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.
If no configuration is set up, DNP3 Master and Slave services are not started.
# 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| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP/ TLS | Serial | Min | Max | ||||
| name | string | User-friendly device name | Yes | Yes | |||
| description | string | Description of a device | No | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used (”dnp3 serial”/”dnp3 tcp” (case insensitive)) | Yes | Yes | DNP3 TCP, DNP3 serial | ||
| mode | string | 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 | No | No | TCP (for DNP3 TCP) SERIAL (for DNP3 serial) | TCP, TLS (for DNP3 TCP) SERIAL (for DNP3 serial) | |
| host | string | IP address of TCP slave device | Yes | - | |||
| bind\_address | string | IP address of network adapter used to connect to slave device | No | No | 0.0.0.0 | ||
| port | integer | TCP communication port | No | No | 20000 | ||
| device | integer | Communication port (”PORT1” or ”PORT2”) | - | Yes | |||
| baudrate | integer | Communication speed, bauds/s | - | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200 | |
| databits | integer | Data bit count for communication | - | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | - | No | 1 | 1 | 2 |
| parity | string | Communication parity option | - | No | none | none, even, odd | |
| flowcontrol | string | Communication device flow control option. | - | No | none | none | |
| tls | boolean | Enable/disable use of TLS | Yes (for TLS) | - | 0 | 0 | 1 |
| tls\_local\_certificate | string | Local certificate for TLS connection | Yes (for TLS) | - | |||
| tls\_peer\_certificate | string | Certificate authority file for TLS connection | No (for TLS) | - | |||
| tls\_private\_key | string | File consisting of private key for TLS connection | No (for TLS) | - | |||
| max\_rx\_frag\_size | integer | Maximum size of a received fragment. | No | No | 2048 | 0 | 2048 |
| destination\_address | integer | Address of a master station | No | No | 1 | 0 | 65535 |
| source\_address | integer | Address of a slave (local) station. | No | No | 1 | 0 | 65535 |
| unsol\_classes | string | Defines which classes will have unsolicited actions on startup. (Example: "1,3,2") | No | No | no class | 1 | 3 |
| unsol\_disable | bool | Disables unsolicited messages on startup. The parameter is going to be ignored if unsol\_classes parameter has any values assigned. | No | No | 0 | 0 | 1 |
| groups\_scan\_mask | integer | 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 - Doublebit 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, Doublebit Binary, Frozen Counter, Analog, Analog Output Status) | No | No | 0 | 0 | 255 |
| groups\_scan\_interval | integer, string | Time between separate groups scans intervals in seconds. Set to 0 to disable. | No | No | 0 | 0 | |
| exception\_scan\_interval | integer, string | Time between exception scan (classes 1,2,3) intervals in seconds. Set to 0 to disable. | No | No | 0 | 0 | |
| integrity\_scan\_interval | integer, string | Time between integrity scan (classes 0,1,2,3) intervals in seconds (general interrogation). Set to 0 to disable. | No | No | 0 | 0 | |
| timesync\_mode | string | Will override masters default setting for choosing timesync procedure | No | No | NON-LAN (for Serial) LAN (for tcp) | LAN, NON-LAN | |
| time\_sync\_interval\_sec | integer, string | Periodic time sync interval in seconds. If 0 < - time syncs are forced and periodic. If = 0 - time syncs react to IIN bits from slave. If < 0 - time syncs are disabled. | No | No | |||
| select\_ms | integer | Select command timeout. Valid for all signals. | No | No | 10000 | ||
| timeout\_ms | integer | Response timeout in milliseconds | No | No | 2000 | ||
| keep\_alive\_timeout | integer | Time interval for sending a keep alive packet in milliseconds. | No | - | 60 | ||
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU | Min | Max | ||||
| signal\_name | string | User-friendly signal name | Yes | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | Yes | |||
| enable | boolean | Enabling/disabling a device | No | No | 1 | 0 | 1 |
| index | integer | Index of a signal. | Yes | Yes | 0 | 65535 | |
| log | boolean | Enable logging in the event log | No | No | 0 | 0 | 1 |
| signal\_type | string | DNP3 signal type. (case insensitive) | Yes | Yes | ”binary”, ”doublebitbinary”, ”binaryoutputstatus”, ”binaryoutputcommand”, ”counter”, ”frozencounter”, ”analog”, ”analogoutputstatus”, ”analogoutputcommand”, ”timeandinterval”, ”octetstring” | ||
| command\_variation | integer | DNP3 command variation. *Supported variations depend on signal type and are provided in the table below* | No | No | 1 | 0 | 4 |
| static\_variation | integer | DNP3 command variation (). Supported variations depend on signal type and are provided in the table below. | No | No | 0, 1, 2, 3, 4, 5, 6, 9, 10 | ||
| event\_variation | integer | DNP3 command variation. Supported variations depend on signal type and are provided in the table below. | No | No | 0 | 8 | |
| control\_code | string | DNP3 control model code of CROB signal. TripClose and Pulse control model requires **PulseOn/off** times to be set | Yes | Yes | LATCH, PULSE, TRIPCLOSE | ||
| pulse\_on\_time\_ms | integer | Pulse ON time in milliseconds, when using Pulse or TripClose control models must be set | Yes | Yes | |||
| pulse\_off\_time\_ms | integer | Pulse OFF time in milliseconds, when using Pulse or TripClose control models must be set | Yes | Yes | |||
| class\_num | integer | Class assignment of the signal. | No | No | 0 | 0 | 3 |
| operate\_type | integer | Default command behaviour. IF selected ”**-1**” - DirectOperateNoAck (FC=6), **”0”** - DirectOperate (FC=5), "**1"** - SelectBeforeOperate (FC=3). | No | No | 1 | -1 | 1 |
| job\_todo | string | The device status signal can be configured by providing one of the given values. | No | No | communication\_status, device\_running, device\_error, unknown\_error | ||
| Signal Type | Available Command Variation | Default Command Variation |
| Binary Output Command (Group12) | 0, 1 | 1 |
| Analog Output Command (Group41) | 0, 1, 2, 3, 4 | 1 |
| Signal Type | Available Variations | Default Variations |
| Binary | Static variation (Group1) 1, 2 Event variation (Group2) 1, 2, 3 | Static variation 2 Event variation 1 |
| Double Binary | Static variation (Group3) 2 Event variation (Group4) 1, 2, 3 | Static variation 2 Event variation 1 |
| Binary Output Status | Static variation (Group10) 1, 2 Event variation (Group11) 1, 2 | Static variation 2 Event variation 1 |
| Counter | Static variation (Group20) 1, 2, 5, 6 Event variation (Group22) 1, 2, 5, 6 | Static variation 1 Event variation 1 |
| Frozen Counter | Static variations (Group21) 1, 2, 5, 6, 9,10 Event variation (Group23) 1, 2, 5, 6 | Static variation 1 Event variation 1 |
| Analog | Static variation (Group30) 1, 2, 3, 4, 5, 6 Event variation (Group32) 1, 2, 3, 4, 5, 6, 7, 8 | Static variation 1 Event variation 1 |
| Analog Output Status | Static variation (Group40) 1, 2, 3, 4 Event variation (Group42) 1, 2, 3, 4, 5, 6, 7, 8 | Static variation 1 Event variation 1 |
| Time and Interval | Static variation (Group50) 1 | Static variation 1 |
| Octet String | Static variation (Group110) 0 Event variation (Group111) 0 | Static variation 0 Event variation 0 |
| Option | Description |
| -h \[ –help \] | Display help information |
| -V \[ –version \] | Show version |
| -p \[ –port \] | Show output for one port only |
| -d <debug level> | Set debugging level |
| -c \[ –config \] | Config path |
| -a \[ –app \] | Show application layer data |
| –l \[ –link \] | Show link layer data |
| –t \[ –transport \] | Show transport layer data |
| -r \[ –redis \] | Show Redis messages |
| -R \[ –readyfile \] | Ready notification file |
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP/ TLS | RTU | Min | Max | ||||
| name | string | User-friendly device name | Yes | Yes | |||
| description | string | Description of a device | No | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | Yes | dnp3 tcp slave dnp3 serial slave | ||
| mode | string | 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 | No | No | TCP or SERIAL | TCP, SERIAL, TLS | |
| host | string | IP address of TCP slave device | Yes | - | |||
| bind\_address | string | IP address of network adapter used to connect to slave device | No | - | 0.0.0.0 | ||
| port | integer | TCP communication port | No | - | 20000 | ||
| device | string | Communication port (”PORT1” or ”PORT2”) | - | Yes | |||
| baudrate | integer | Communication speed, bauds/s | - | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200 | |
| databits | integer | Data bit count for communication | - | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | - | No | 1 | 1 | 2 |
| parity | string | Communication parity option | - | No | none | none, even, odd | |
| flowcontrol | string | Communication device flow control option. | - | No | none | none | |
| tls | boolean | Enable/disable use of TLS | Yes (for TLS) | - | 0 | 0 | 1 |
| tls\_local\_certificate | string | Local certificate for TLS connection | Yes (for TLS) | - | |||
| tls\_peer\_certificate | string | Certificate authority file for TLS connection | No (for TLS) | - | |||
| tls\_private\_key | string | File consisting of private key for TLS connection | No (for TLS) | - | |||
| max\_tx\_frag\_size | integer | Maximum size of a received fragment. | No | No | 2048 | 0 | 2048 |
| destination\_address | integer | Address of a master station | No | No | 1 | 0 | 65535 |
| source\_address | integer | Address of a slave (local) station. | No | No | 1 | 0 | 65535 |
| unsol\_classes | string | Defines which classes will have unsolicited actions on startup. (Example: "1,3,2") | No | No | no class | 1 | 3 |
| time\_sync\_interval\_sec | integer, string | Periodic time sync interval in seconds. If 0 < - time syncs are forced and periodic. If = 0 - time syncs react to IIN bits from slave. If < 0 - time syncs are disabled. | No | No | 0 | 0 | |
| select\_ms | integer | Select command timeout. Valid for all signals. | No | No | 10000 | ||
| timeout\_ms | integer | Response timeout in milliseconds | No | No | 2000 | ||
| keep\_alive\_timeout | integer | Time interval for sending a keep alive packet in milliseconds. | No | No | 60 | ||
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU | Min | Max | ||||
| signal\_name | string | User-friendly signal name | Yes | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | No | 1 | 0 | 1 |
| index | integer | Index of a signal. | Yes | Yes | 0 | 65535 | |
| log | bolean | Enable logging in event log | No | No | 0 | 0 | |
| deadband | integer, string | Deadband for Analog, Analog Output Status, Counter, Frozen Counter signals. | No | No | 0 | ||
| signal\_type | string | DNP3 signal type. (case insensitive) | Yes | Yes | ”binary”, ”doublebitbinary”, ”binaryoutputstatus”, ”binaryoutputcommand”, ”counter”, ”frozencounter”, ”analog”, ”analogoutputstatus”, ”analogoutputcommand”, ”timeandinterval”, ”octetstring” | ||
| command\_variation | integer | DNP3 command variation. *Supported variations depend on signal type and are provided in table below* | No | No | 1 | 0 | 4 |
| static\_variation | integer | Override default signal’s static variation. Valid for Status mode signals. | No | No | 0, 1, 2, 3, 4, 5, 6, 9, 10 | ||
| event\_variation | integer | Override default signal’s event variation. Valid for Status mode signals. | No | No | 0 | 8 | |
| control\_code | string | DNP3 control model code of CROB signal. TripClose and Pulse controlmodel requires **PulseOn/off** times to be set | Yes | Yes | LATCH, PULSE, TRIPCLOSE | ||
| pulse\_on\_time\_ms | integer | Pulse ON time in milliseconds, when using Pulse or TripClose control models must be set | Yes | Yes | |||
| pulse\_off\_time\_ms | integer | Pulse OFF time in milliseconds, when using Pulse or TripClose control models must be set | Yes | Yes | |||
| class\_num | integer | Class assignment of this signal. | No | No | 0 | 0 | 3 |
| operate\_type | integer | Default command behaviour. If selected: ”**-1**” - DirectOperateNoAck (FC=6), **”0”** - DirectOperate (FC=5), "**1"** - SelectBeforeOperate (FC=3). | No | No | 1 | -1 | 1 |
| job\_todo | string | Device status signal can be configured by providing one of the given values. | No | No | communication\_status, device\_running, device\_error, unknown\_error | ||
| Signal Type | Available Command Variation | Default Command Variation |
| Binary Output Command (Group12) | 0, 1 | 1 |
| Analog Output Command (Group41) | 0, 1, 2, 3, 4 | 1 |
| Signal Type | Available Variations | Default Variations |
| Binary | Static variation (Group1) 1, 2 Event variation (Group2) 1, 2, 3 | Static variation 2 Event variation 1 |
| Double Binary | Static variation (Group3) 2 Event variation (Group4) 1, 2, 3 | Static variation 2 Event variation 1 |
| Binary Output Status | Static variation (Group10) 2 Event variation (Group11) 1, 2 | Static variation 2 Event variation 1 |
| Counter | Static variation (Group20) 1, 2, 5, 6 Event variation (Group22) 1, 2, 5, 6 | Static variation 1 Event variation 1 |
| Frozen Counter | Static variations (Group21) 1, 2, 5, 6, 9,10 Event variation (Group23) 1, 2, 5, 6 | Static variation 1 Event variation 1 |
| Analog | Static variation (Group30) 1, 2, 3, 4, 5, 6 Event variation (Group32) 1, 2, 3, 4, 5, 6, 7, 8 | Static variation 1 Event variation 1 |
| Analog Output Status | Static variation (Group40) 1, 2, 3, 4 Event variation (Group42) 1, 2, 3, 4, 5, 6, 7, 8 | Static variation 1 Event variation 1 |
| Time and Interval | Static variation (Group50) 1 | Static variation 1 |
| Octet String | Static variation (Group110) 0 Event variation (Group111) 0 | Static variation 0 Event variation 0 |
| Option | Description |
| -h \[ –help \] | Display help information |
| -V \[ –version \] | Show version |
| -p \[ –port \] | Show output for one port only |
| -d <debug level> | Set debugging level |
| -c \[ –config \] | Config path |
| -a \[ –app \] | Show application layer data |
| –l \[ –link \] | Show link layer data |
| –t \[ –transport \] | Show transport layer data |
| -r \[ –redis \] | Show Redis messages |
| -R \[ –readyfile \] | Ready notification file |
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU/ASCII | Min | Max | ||||
| name | string | User-friendly name for a device | Yes | Yes | |||
| description | string | Description of a device | No | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | Yes | Modbus RTU, Modbus TCP | ||
| ip | string | IP address of TCP slave device | Yes | - | |||
| port | integer | TCP communication port | Yes | - | 502 | ||
| bind\_address | string | IP address of network adapter used to connect to slave device (Default: ”0.0.0.0”) | No | No | 0.0.0.0 | ||
| id | integer | Modbus Slave ID | Yes | Yes | |||
| mode | string | Choosing between RTU (”rtu”), ASCII (”ascii”) and TCP(”tcp”) modes. ASCII is the same as RTU, but with ASCII symbols. | No | No | TCP (for TCP) RTU (for Serial) | rtu, ascii, tcp | |
| timeout\_ms | integer | Response timeout in milliseconds | Yes | Yes | 10000 | ||
| device | string | Communication port (”PORT1”/”PORT2”) | - | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed, baud/s | - | Yes | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | - | Yes | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | - | Yes | 1 | 1 | 2 |
| parity | string | Communication parity option | - | Yes | none | none, even, odd | |
| flowcontrol | string | Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued | - | Yes | none | none | |
| scan\_rate\_ms | integer | 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) | Yes | Yes | 300 | ||
| retry\_count | integer | Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued | No | No | 3 | ||
| serial\_delay | integer | RS485 delay between read and write operations in milliseconds | - | Yes | 50 | ||
| keep\_alive\_timeout | integer | Time interval for sending a keep alive packet (in milliseconds) | No | No | 60 | ||
| modbus\_multi\_write | boolean | Use 15/16 functions to write 1 register/coil (Default: 0) | No | No | 0 | 0 | 1 |
| comm\_restart\_delay | integer | Time delay between disconnecting from slave device and restarting connection (in milliseconds) (Default: 500) | No | - | 500 | ||
| update | boolean | Enable to keep updating the tags even if they have the same value. | No | No | 0 | 0 | 1 |
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU/ASCII | Min | Max | ||||
| signal\_name | string | User-friendly signal name | Yes | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be Yes used | Yes | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | No | 1 | 0 | 1 |
| job\_todo | string | 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 | Yes | Yes | |||
| tag\_job\_todo | string | 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 | Yes | Yes | |||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | Yes | |||
| log | integer | Size of this signal’s log in Event log. | No | No | 0 | ||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | No | 0 | ||
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
##### Modbus Slave parameters for Devices tab| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU/ASCII | Min | Max | ||||
| name | string | User-friendly name for a device | Yes | Yes | |||
| description | string | Description of a device | No | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | unknown | ||
| enable | boolean | Enabling/disabling of a device | No | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | Yes | Modbus serial Slave, Modbus TCP Slave | ||
| host | string | Space separated host IP addresses of master device | Yes | - | |||
| port | integer | TCP port to listen for incoming connections | Yes | - | |||
| bind\_address | string | IP address of network adapter used to connect to slave device (Default: ”0.0.0.0”) | No | No | 0.0.0.0 | ||
| keep\_alive\_timeout | integer | Minimum time a connection can be idle without being closed in milliseconds | No | No | 60 | ||
| mode | string | Choosing between RTU (”rtu”), ASCII (”ascii”) and TCP(”tcp”) modes. ASCII is the same as RTU, but with ASCII symbols. | No | No | TCP (for TCP) RTU (for Serial) | rtu, ascii, tcp | |
| device | string | Communication port (”PORT1”/”PORT2”) | - | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed, baud/s | - | Yes | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | - | Yes | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | - | Yes | 1 | 1 | 2 |
| parity | string | Communication parity option | - | Yes | none | none, even, odd | |
| flowcontrol | string | Communication device’s flow control option. | - | No | none | none | |
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU/ASCII | Min | Max | ||||
| signal\_name | string | User-friendly signal name | Yes | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be Yes used | Yes | Yes | |||
| enable | boolean | Enabling/disabling an individual signal | No | No | 1 | 0 | 1 |
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.). This defines the size that will be read. | Yes | Yes | |||
| log | integer | Size of this signal’s log in the Event log. | No | No | 0 | ||
| slave\_id | integer | Address of a slave device | Yes | Yes | |||
| function | integer | Function number | Yes | Yes | |||
| register\_address | integer | Register address | Yes | Yes | |||
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.
#### 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 -dIf 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.
To launch a debugging session, a user should stop `modbus-slave` process and run `modbus-slave` command with respective flags as shown above.
# 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 & 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. 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** [](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 RS485). Its full functionality list can be found in an [IEC 60870-5-101 PID Interoperability List](https://wiki.elseta.com/link/180#bkmrk-pid%27s) 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| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | IEC 60870-5-101 master | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option | No | none | none, even, odd | |
| flowcontrol | string | Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued | No | none | none | |
| link\_address | integer | Destination address when in transmit and source address when broadcasting | Yes | 0 | 65535 | |
| link\_size | integer | Link address size in bytes | No | 1 | 1 | 2 |
| asdu\_address | integer | Application Service Data Unit address | Yes | 0 | 65535 | |
| asdu\_size | integer | Common address size in bytes | No | 1 | 1 | 2 |
| ioa\_size | integer | Information object address (IOA) size in bytes | No | 2 | 1 | 3 |
| cot\_size | integer | Cause of transmission (COT) size in bytes | No | 1 | 1 | 2 |
| time\_sync\_interval\_sec | integer | 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. | No | 60 | ||
| gi\_interval\_sec | integer | Time frame between General Interrogation requests in seconds, if 0 requests are disabled | No | 300 | ||
| scan\_rate\_ms | integer | Polling interval in milliseconds. Time frame between two telegrams from master | Yes | 100 | ||
| timeout\_ms | integer | Response timeout in milliseconds | Yes | 1000 | ||
| retry\_count | integer | Number of retries of failed requests before announcing that device is in Error state | Yes | 1 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| source\_device\_alias | string | device\_alias of a source device | For commands | |||
| source\_signal\_alias | string | signal\_alias of a source signal | For commands | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged | No | 0 | ||
| gi | boolean | Including/excluding (1 or 0) signal from General Interrogation | No | 0 | 0 | 1 |
| common\_address | integer | Address of a destination device | Yes | 1 | ||
| info\_address | integer | Information object address | Yes | |||
| data\_type | integer | ASDU type identifier | Yes | 1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14, 30, 31, 32, 34, 35, 36, 45, 46, 47, 48, 49, 50 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | IEC 60870-5-101 slave | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option | No | none | none, even, odd | |
| flowcontrol | string | Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued | No | none | none | |
| link\_address | integer | Destination address when in transmit and source address when broadcasting | Yes | 0 | 65535 | |
| link\_size | integer | Link address size in bytes | No | 1 | 1 | 2 |
| asdu\_size | integer | Common address size in bytes | No | 1 | 1 | 2 |
| ioa\_size | integer | Information object address (IOA) size in bytes | No | 2 | 1 | 3 |
| cot\_size | integer | Cause of transmission (COT) size in bytes | No | 1 | 1 | 2 |
| time\_sync | boolean | Allow time synchronization, 1 to enable and 0 to disable | No | 0 | 0 | 1 |
| message\_size | integer | Maximum length of a message | Yes | 253 | 0 | 255 |
| cache\_size | integer | Maximum number of events to store in a buffer | No | 100 | 0 | 1000 |
| respond\_delay | integer | Time in microseconds to wait before sending responses | Yes | 100 | 0 | 1000000 |
| single\_byte\_ack | boolean | Use single character acknowledge, 1 to enable and 0 to disable | No | 0 | 0 | 1 |
| keep\_alive\_timeout | integer | Time interval in seconds before serial connection is considered offline | No | 60 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be Yes used | Yes | |||
| source\_device\_alias | string | device\_alias of a source device | For commands | |||
| source\_signal\_alias | string | signal\_alias of a source signal | For commands | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged | No | 0 | ||
| gi | boolean | Including/excluding (1 or 0) signal from General Interrogation | No | 0 | 0 | 1 |
| common\_address | integer | Address of a destination device | Yes | |||
| info\_address | integer | Information object address | Yes | |||
| data\_type | integer | ASDU type identifier | Yes | 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 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | IEC 60870-5-103 master | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 8 | |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option | No | none | none, even, odd | |
| flowcontrol | string | Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued | No | none | none | |
| link\_address | integer | Destination address when in transmit and source address when broadcasting | Yes | 0 | 65535 | |
| asdu\_address | integer | Application Service Data Unit address | Yes | 0 | 65535 | |
| time\_sync\_interval\_sec | integer | Time frame between Time Synchronization requests in seconds | No | 60 | ||
| gi\_interval\_sec | integer | Time frame between General Interrogation requests in seconds, if 0 requests are disabled | Yes | 300 | ||
| scan\_rate\_ms | integer | Polling interval in milliseconds. Time frame between two telegrams from master | No | 100 | ||
| timeout\_ms | integer | Response timeout in milliseconds | No | 1000 | ||
| serial\_delay | integer | Communication device’s serial delay in milliseconds. Time frame in which master station is not TX’ing after last RX byte | No | 50 | ||
| retry\_count | integer | Number of retries of failed requests before announcing that device is in Error state | No | 3 | ||
| retry\_delay\_ms | integer | Time before the next retry in milliseconds | No | 500 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be Yes used | Yes | |||
| source\_device\_alias | string | device\_alias of a source device | For commands | |||
| source\_signal\_alias | string | signal\_alias of a source signal | For commands | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged | No | 0 | ||
| gi | boolean | Including/excluding (1 or 0) signal from General Interrogation | No | 0 | 0 | 1 |
| common\_address | integer | Address of a destination device | Yes | |||
| function | integer | Function number | No | 0 | ||
| info\_address | integer | Information object address | Yes | |||
| info\_number | integer | Information number | Yes | |||
| data\_type | integer | ASDU type identifier | No | 0 | 0, 1, 2, 3, 4, 9, 20 | |
| fleeting | boolean | Mark signal as fleeting type (1 or 0). Fleeting signals have go to DPI::OFF after defined time | No | 0 | 1 | |
| normalise\_time\_ms | integer | Time in milliseconds between station receiving DPI::ON and automatically switching to DPI::OFF | If fleeting is used | 100 | ||
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.
If no configuration is set up, IEC104 Master and Slave services are not started.
#### 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| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | IEC 60870-5-104 master | ||
| asdu\_address | integer | Application Service Data Unit address | Yes | 0 | 65535 | |
| asdu\_size | integer | Common address size in bytes | No | 2 | 1 | 2 |
| time\_sync\_interval\_sec | integer | Time frame between Time Synchronization requests in seconds | Yes | 60 | ||
| gi\_interval\_sec | integer | Time frame between General Interrogation requests in seconds. If 0 requests are disabled | Yes | 300 | ||
| port | integer | TCP port | Yes | 0 | 65535 | |
| ioa\_size | integer | Information object address (IOA) size in bytes | No | 3 | 1 | 3 |
| swt | integer | Send window (k) | Yes | |||
| rwt | integer | Receive window (w) | Yes | |||
| cot\_size | integer | Cause of transmission (COT) size in bytes | No | 2 | 1 | 3 |
| ip | string | Host IP address (ipv4) | Yes | |||
| t1\* | integer | Acknowledge timeout t1 (sec) | Yes | 15 | 1 | 255 |
| t2\* | integer | Connection ACKRSN clock t2 (sec) | Yes | 10 | 1 | 254 |
| t3\* | integer | Connection TESTFR clock t3 (sec) | Yes | 20 | 1 | 172800 |
| originator | integer | Provides a means for a controlling station to explicitly identify itself | No | 0 | 0 | 255 |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be Yes used | Yes | |||
| source\_device\_alias | string | device\_alias of a source device | For commands | |||
| source\_signal\_alias | string | signal\_alias of a source signal | For commands | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged | No | 0 | ||
| gi | boolean | Including/excluding (1 or 0) signal from General Interrogation | No | 0 | 0 | 1 |
| common\_address | integer | Address of a destination device | Yes | |||
| function | integer | Function number | No | 0 | ||
| info\_address | integer | Information object address | Yes | |||
| data\_type | integer | ASDU type identifier | Yes | 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 | ||
| select\_ms | integer | 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. | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | IEC 60870-5-104 slave | ||
| asdu\_size | integer | Common address size in bytes | No | 2 | 1 | 2 |
| time\_sync | boolean | Enable/disable (1 or 0) time synchronization | Yes | |||
| port | integer | TCP port | No | 2404 | 0 | 65535 |
| ioa\_size | integer | Information object address (IOA) size in bytes | No | 3 | 1 | 3 |
| swt | integer | Send window (SWT) | No | 12 | ||
| rwt | integer | Receive window (RWT) | No | 8 | ||
| cot\_size | integer | Cause of transmission (COT) size in bytes | No | 2 | 1 | 3 |
| host | string | Space-separated remote host IP addresses (ipv4) | Yes | |||
| bind\_address | string | Bind to local IP address (ipv4) | No | 0.0.0.0 | ||
| t1 | integer | Acknowledge timeout t1 (sec) | Yes | 15 | 1 | 255 |
| t2 | integer | Connection ACKRSN clock t2 (sec), t2 should be less than t1 | Yes | 10 | 1 | 254 |
| t3 | integer | Connection TESTFR clock t3 (sec) | Yes | 20 | 1 | 172800 |
| message\_size | boolean | The maximum length of a message | Yes | 253 | 0 | 255 |
| cache\_size | integer | Amount of data to be cached | Yes | 100 | 0 | 1000 |
| tls | boolean | Enable/disable the use of TLS | No | 0 | 0 | 1 |
| tls\_local\_certificate | string | Local certificate for TLS connection | Yes (for TLS) | |||
| tls\_peer\_certificate | string | Certificate authority file for TLS connection | No | |||
| tls\_private\_key | string | A file consisting of the private key for TLS connection | No | |||
| command\_timeout\_ms | integer | Time to execute a command before responding negatively. | No | 30000 | 0 | |
| command\_age\_ms | integer | The amount of time shift allowed for the command to still be executed. | No | 0 | 0 | |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be Yes used | Yes | |||
| source\_device\_alias | string | device\_alias of a source device | For commands | |||
| source\_signal\_alias | string | signal\_alias of a source signal | For commands | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged | No | 0 | 0 | 1 |
| gi | boolean | Including/excluding (1 or 0) signal from General Interrogation | No | 0 | 0 | 1 |
| common\_address | integer | Address of a destination device | Yes | |||
| info\_address | integer | Information object address | Yes | |||
| data\_type | integer | ASDU type id. | Yes | 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 | ||
| select\_ms | integer | 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. | No | 0 | ||
As of version v1.5.0, WCC Lite supports MMS type messaging. Logging and groups setting services are not supported.
# 15.2 IEC 61850 Server WCC Lite can act as a 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 master protocol to either to succeed or fail. If feedback is not received within **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).When using SBO commands, select is not routed to master protocol and select logic is performed only in IEC 61850 Server protocol.
#### Configuring data points To use IEC 61850 Server in WCC Lite, it has to be configured via an Excel configuration and data model must be uploaded. This configuration contains two Excel sheets where parameters have to be filled in - Devices and Signals. ##### IEC 61850 Server parameters for Devices tab| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | IEC 61850 Server | ||
| bind\_address | string (IP address format) | IP address of and interface to use with server | No | 0.0.0.0 | ||
| host | string (IP address format) | IP address list of allowed IPs (separated with spaces) | Yes | |||
| port | integer | TCP communication port | No | 102 | ||
| auth | string | Authorization type | Yes | “NONE”, “PASSWORD”, “TLS” | ||
| password | string | Authorization password for server device | Yes ( for PASSWORD) | |||
| tls\_local\_certificate | string | Local certificate for TLS connection | Yes (for TLS) | |||
| tls\_peer\_certificate | string | Certificate authority file for TLS connection | Yes (for TLS) | |||
| tls\_private\_key | string | File consisting of private key for TLS connection | Yes (for TLS) | |||
| ied\_name | string | Name of an Intelligent Electronic Device | Yes | |||
| originator | string | Origin identification for device | No | |||
| model\_filename | string | Filename of server model, without .server extension | Yes | |||
| command\_ack\_timeout\_ms | integer | Timeframe (ms) in which enhanced-security commands must be acknowledged (Default: 3000) | No | 3000 | ||
| report\_buffered\_size | integer | Report control blocks buffer size in bytes (Default: 65536) | No | 65536 | ||
| report\_unbuffered\_size | integer | Unbuffered report control blocks buffer size in bytes (Default: 65513) | No | 65513 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | boolean | Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged | No | 0 | ||
| number\_type | string | Number format type (BOOLEAN, FLOAT, INT16, etc.) | Yes | 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 | ||
| ld\_instance | string | Instance of a logical device | Yes | |||
| ln\_class | string | Logical node class type | Yes | |||
| ln\_instance | integer | Instance of a logical node | No | |||
| ln\_prefix | string | Prefix of logical node string | No | |||
| cdc | string | Common Data Class (CDC) name | Yes | SPS, DPS, INS, ENS, ACT, ACD, MV, CMV, SAV, SPC, DPC, INC, ENC, BSC, ISC, APC, BAC | ||
| data\_object | string | Name of data object in dataset | Yes | |||
| da\_value | string | Name of a data attribute value node | Yes | |||
| da\_fc | string | Functional constrain for data object | Yes | ST,MX, CO, SP | ||
| control\_model | string | Model of output control | Yes (for commands) | read-only | read-only, direct-with-normal-security, sbo-with-normal-security, direct-with-enhanced-security, sbo-with-enhanced-security | |
If 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 command line interface and find out why the link is not functioning properly.
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:
``` 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.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.
#### 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:| Common Data Class | Function Constraint | Data attributes |
| SPS DPS INS ENS | ST | stVal |
| ACT | ST | general phsA phsB phsC neut |
| ACD | ST | general dirGeneral phsA dirPhsA phsB dirPhsB phsC dirPhsC neut dirNeut |
| MV | MX | instMag mag |
| CMV | MX | instCVal cVal |
| SAV | MX | instMag |
| SPC DPC INC ENC | ST | stVal |
| BSC ISC | ST | valWTr |
| APC BAC | MX | mxVal |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | IEC 61850 Client | ||
| host | string (IP address format) | IP address of server device | Yes | |||
| port | integer | TCP communication port | Yes | 102 | ||
| auth | string | Authorization type | Yes | none, password, tls | ||
| password | string | Authorization password for server device | Yes (for PASSWORD) | |||
| tls\_local\_certificate | string | Local certificate for TLS connection | Yes (for TLS) | |||
| tls\_peer\_certificate | string | Certificate authority file for TLS connection | Yes (for TLS) | |||
| tls\_private\_key | string | File consisting of private key for TLS connection | Yes (for TLS) | |||
| ied\_name | string | Name of an Intelligent Electronic Device | Yes | |||
| originator | string | Origin identifier for device | No | |||
| model\_filename | string | Filename of client model uploaded to WCC (must contain .client extension) | Yes | |||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | boolean | Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged | No | 0 | ||
| number\_type | string | Number format type | Yes | 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 | ||
| ld\_instance | string | Instance of a logical device | Yes | |||
| ln\_class | string | Logical node class type | Yes | |||
| ln\_instance | integer | Instance of a logical node | No | |||
| ln\_prefix | string, integer | Prefix of logical node string | No | |||
| cdc | string | Common Data Class (CDC) name | Yes | 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 | ||
| data\_object | string | Name of data object in dataset | Yes | |||
| da\_value | string | Name of a data attribute value node | Yes | |||
| da\_fc | string | Functional constrain for data object | Yes | ST,MX, CO, SP, SE | ||
| control\_model | string | Model of output control | No | read-only | read-only, direct-with-normal-security, sbo-with-normal-security, direct-with-enhanced-security, sbo-with-enhanced-security | |
| dataset | string | Full object reference of a dataset | Yes | |||
| report\_control\_block | string | Full object reference of a report control block | Yes | |||
| intgPd | integer | Integrity period in milliseconds | No | 0 | ||
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
##### Device status signalsIf 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.
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.
# 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| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | at command | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option | No | none | none, even, odd | |
| flowcontrol | string | Communication device flow control option. | No | none | none | |
| timeout\_ms | integer | Timeout of waiting for incoming request in milliseconds | Yes | 0 | 60000 | |
| serial\_close\_delay | integer | Delay before closing serial port | No | 400 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Tag job as single or multiple comma separated OBIS codes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of the device | No | |||
| device\_alias | string | Device alias to be used in configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | Aurora | ||
| baudrate | integer | Communication speed, bauds/s (See values 33.1.2) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option (”none”/”even”/”odd”) | No | none | None, Even, Odd | |
| flowcontrol | string | Communication device flow control option. | No | none | ||
| scan\_rate\_ms | integer | If provided and positive all reads and writes will be executed within the timeframe in milliseconds. | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout in milliseconds | No | 2500 | ||
| id | integer | Inverter ID | No | 0 | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly device name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log (Default: 0) | No | 0 | 0 | |
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| job\_todo | boolean | Define tag-function | Yes | |||
| tag\_job\_todo | string | Define tag action that depends on tag function | Yes | |||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of the device | No | |||
| device\_alias | string | Device alias to be used in configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | Comlynx | ||
| address | integer | Device address | No | 1 | ||
| subnet | integer | Subnet address | No | 0 | ||
| network | integer | Network address | No | 0 | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 19200 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option (”none”/”even”/”odd”) | No | none | ||
| flowcontrol | string | Communication device flow control option. (Default: (case-sensitive): ”none”) | No | none | ||
| scan\_rate\_ms | integer | If provided and positive all reads and writes will be executed within the timeframe in milliseconds. | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout in milliseconds | Yes | 0 | 60000 | |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly device name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. | No | 0 | ||
| job\_todo | boolean | Define tag-function | Yes | |||
| tag\_job\_todo | string | Define tag action that depends on tag function | Yes | |||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of the device | No | |||
| device\_alias | string | Device alias to be used in configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | Delta | ||
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option (”none”/”even”/”odd”) | No | none | None, Even, Odd | |
| flowcontrol | string | Communication device flow control option. (Default: (case-sensitive): ”none”) | No | none | ||
| scan\_rate\_ms | integer | If provided and positive all reads and writes will be executed within the timeframe in milliseconds. | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout in milliseconds | Yes | 0 | 60000 | |
| id | integer | Inverter ID | Yes | 0 | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Tag job as single or multiple comma separated OBIS codes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of the device | No | |||
| device\_alias | string | Device alias to be used in configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | Ginlong | ||
| baudrate | integer | Communication speed (bauds/s) (See values 33.1.2) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option (”none”/”even”/”odd”) | No | none | None, Even, Odd | |
| flowcontrol | string | Communication device flow control option. (Default: (case-sensitive): ”none”) | No | none | ||
| scan\_rate\_ms | integer | If provided and positive all reads and writes will be executed within the timeframe in milliseconds. | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout in milliseconds | No | 2500 | ||
| id | integer | Inverter ID | Yes | 0 | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly device name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. | No | 0 | ||
| job\_todo | string | Define tag-function | Yes | |||
| tag\_job\_todo | string | Define tag action that depends on tag function | Yes | |||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
This protocol handles serial communication parameters (baudrate, databits, stopbits, etc.) automatically.
### Configuration ##### Kaco parameters for *Device* tab| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | Kaco | ||
| scan\_rate\_ms | integer | All reads and writes will be executed within the timeframe in milliseconds. | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout of waiting for incoming request in miliseconds | Yes | 2500 | 0 | 60000 |
| subid | integer | Inverter serial number display | Yes | 0 | ||
| ext\_device | boolean | 0 - Inverter is connected directly 1 - Inverter is connected via remote terminal | Yes | 0 | 0 | 1 |
| id | integer | Inverter serial number | Yes | |||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Tag job as single or multiple comma separated OBIS codes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | powerone | ||
| serialnumber | integer | Inverter serial number | Yes | |||
| type | string | Inverter type : - CU Collecting unit - CB Normal CB - HID HID with integrated CB | No | CU | CU, CB, HID | |
| device | Communication port | Yes | PORT1 | PORT2 | ||
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200 | |
| scan\_rate\_ms | integer | Delay before closing serial port in milliseconds | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout of waiting for incoming request in milliseconds | Yes | 1000 | 0 | 60000 |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Tag job as single or multiple comma separated OBIS codes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | sma net | ||
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option | No | none | none, even, odd | |
| flowcontrol | string | Communication device flow control option. | No | none | none | |
| scan\_rate\_ms | integer | Delay before closing serial port in milliseconds | No | 10000 | ||
| poll\_delay\_ms | integer | No | 200 | |||
| timeout\_ms | integer | Timeout of waiting for incoming request in milliseconds | No | 2500 | ||
| serial\_number | string | Inverter serial number | Yes | |||
| device | Communication port | Yes | PORT1 | PORT2 | ||
| serial\_close\_delay | integer | Delay before closing serial port | No | 400 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Tag job as single or multiple comma separated OBIS codes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | Solplus | ||
| scan\_rate\_ms | integer | All reads and writes will be executed within the timeframe in milliseconds | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout of waiting for incoming request in milliseconds | No | 2500 | 0 | 60000 |
| url | string | HTTP server location URL | Yes | |||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Tag job as single or multiple comma separated OBIS codes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of the device | No | |||
| device\_alias | string | Device alias to be used in configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | Vbus | ||
| slave\_address | integer | Slave device address | Yes | 0 | 255 | |
| master\_address | integer | Master device address | Yes | 0 | 255 | |
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option | No | none | none, even, odd | |
| flowcontrol | string | Communication device flow control option. | No | none | none | |
| scan\_rate\_ms | integer | If provided and positive all reads and writes will be executed within the timeframe in milliseconds. | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout in milliseconds | No | 2500 | 0 | 60000 |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly device name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. | No | 0 | 0 | |
| job\_todo | string | Define tag-function | Yes | |||
| tag\_job\_todo | string | Define tag action that depends on tag function | Yes | |||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of the device | No | |||
| device\_alias | string | Device alias to be used in configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | Vestas | ||
| slave\_address | integer | Slave device address | Yes | 0 | 255 | |
| master\_address | integer | Master device address | No | 0 | 0 | 255 |
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option (”none”/”even”/”odd”) | No | none | none, even, odd | |
| flowcontrol | string | Communication device flow control option. (Default: (case-sensitive): ”none”) | No | none | ||
| scan\_rate\_ms | integer | If provided and positive all reads and writes will be executed within the timeframe in milliseconds. | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout in milliseconds | No | 500 | 0 | 60000 |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly device name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. | No | 0 | ||
| job\_todo | string | Define tag-function | Yes | |||
| tag\_job\_todo | string | Define tag action that depends on tag function | Yes | |||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | Windlog | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 115200 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option | No | none | none, even, odd | |
| flowcontrol | string | Communication device flow control option. | No | none | none | |
| timeout\_ms | integer | Timeout of waiting for incoming request in milliseconds | Yes | 0 | 60000 | |
| serial\_close\_delay | integer | Delay before closing serial port | No | 400 | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in the event log | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Tag job as single or multiple comma-separated OBIS codes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU | Min | Max | ||||
| name | string | User-friendly device name | Yes | Yes | |||
| description | string | Description of a device | No | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | |||
| enable | boolean | Enabling/disabling a device | No | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | Yes | mbus serial, mbus tcp | ||
| scan\_rate\_ms | integer | All reads and writes will be executed within the timeframe in milliseconds. | No | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | No | 200 | ||
| timeout\_ms | integer | Timeout of waiting for an incoming response in milliseconds | Yes | Yes | 0 | 60000 | |
| address | string | Device address | Yes | Yes | |||
| device | string | Communication port | - | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (baud/s) | - | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | - | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | - | No | 1 | 1 | 2 |
| parity | string | Communication parity option | - | No | none | none, even, odd | |
serial_close_delay | integer | Delay before closing the serial connection. | - | No | 400 | ||
| ip | string | The IP address of the TCP slave device | Yes | - | |||
| port | integer | TCP communication port | Yes | - | 0 | 65535 | |
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU | Min | Max | ||||
| signal\_name | string | User-friendly signal name | Yes | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | No | 1 | 0 | 1 |
| log | integer | Enable logging in the event log | No | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | Yes | |||
| job\_todo | string | Tag job as single or multiple comma-separated OBIS codes | Yes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | Yes | |||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | kostal | ||
| id | integer | Kostal device id | Yes | |||
| device | Communication port | Yes | PORT1 | PORT2 | ||
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200 | |
| databits | integer | Data bit count for communication | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | No | 1 | 1 | 2 |
| parity | string | Communication parity option | No | none | none, even, odd | |
| scan\_rate\_ms | integer | Delay before closing serial port in milliseconds | No | 10000 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | 200 | ||
| timeout\_ms | integer | Timeout of waiting for incoming request in milliseconds | Yes | 0 | 60000 | |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | ||
| number\_type | string | Type of a number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Tag job as single or multiple comma separated OBIS codes | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
| pulse\_short\_time\_ms | integer | Time interval for short output pulse to stay active | No | 0 | ||
| pulse\_long\_time\_ms | integer | Time interval for long output pulse to stay active | No | 0 | ||
Before configuring the Device section it is best to first check the connection parameters with a 3rd party DLMS utility.
**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.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.
When ip and port are configured, any serial port settings are ignored and connection is initiated only via IP.
Device configuration parameters for DLMS meters acquisition:| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU | Min | Max | ||||
| name | string | User-friendly name for a device | Yes | Yes | |||
| description | string | Description of a device | No | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | Yes | DLMS | ||
| serial\_number | integer | Meter serial number | No | No | 0 | ||
| physical\_address | integer | Meter physical server address | No | No | 1600 | ||
| logical\_address | integer | Meter logical server address | No | No | 0 | ||
| address\_size | integer | Meter address size in bytes | No | No | 1 | 1 | 4 |
| client\_address | integer | Client address | Yes | Yes | |||
| type | string | Meter object referencing: SN - short referencing, LN - logical referencing | No | No | SN | SN, LN | |
| mode | string | Initial handshake mode. | Yes | Yes | DLMS-HDLC | IEC, DLMS, DLMS-HDLC or DLMS-WRAPPER | |
| timeout\_ms | integer | Timeout in milliseconds | No | No | 2500 | ||
| auth | string | Authentication. | No | No | None | None, Low, High, HighMd5, HighSha1, HighSha256, HighGmac, HighEcdsa | |
| password | string | Password for authentication | No (when auth is None) | No (when auth is None) | |||
| ip | string | IP address | Yes | - | |||
| port | integer | TCP port | Yes | - | |||
| device | Communication port | - | Yes | PORT1 | PORT2 | ||
| baudrate | integer | Communication speed (bauds/s) | - | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | - | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | - | No | 1 | 1 | 2 |
| parity | string | Communication parity option | - | No | none | none, even, odd | |
| flowcontrol | string | Communication device flow control option. | - | No | none | none | |
| retry\_counter | integer | Number of requests, before link is considered lost (device status signals are changed) and reconnect attempt will be issued | No | No | 3 | ||
| scan\_rate\_ms | integer | If provided and positive all reads and writes will be executed within the timeframe in milliseconds | No | No | 10000 | ||
| reconnect\_time | integer | Defines how often (in milliseconds) the client will try to reestablish communication with the meter after an unsuccessful attempt. | No | No | 1000 | ||
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU | Min | Max | ||||
| signal\_name | string | User-friendly signal name | Yes | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | No | 1 | 0 | 1 |
| log | boolean | Enable logging in event log | No | No | 0 | 0 | 1 |
| short\_name | integer | Address of value to read (Short name). | No | No | 0 | ||
| obis\_job | string | 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). | Yes | Yes | |||
| Option | Description |
| -h \[ –-help \] | Display help information |
| -V \[ –-version \] | Show version |
| -p \[ -–port \] | Show output for one port only |
| -d <debug level> | Set debugging level |
| -c \[ –-config \] | Config path |
If **ip** or **port** parameters are configured, any serial port settings are ignored and connections are initiated via TCP.
IEC 62056-21 device configuration parameters:| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU | Min | Max | ||||
| name | string | User-friendly name for a device | Yes | Yes | |||
| description | string | Description of a device | No | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | Yes | IEC 62056-21 | ||
| poll\_delay\_ms | integer | Minimum time delay in milliseconds to wait before sending any data on port. | No | No | 200 | ||
| scan\_rate\_ms | integer | No | No | 10000 | |||
| device | string | Communication port | - | No | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | - | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 | |
| databits | integer | Data bit count for communication | - | No | 8 | 6 | 9 |
| stopbits | integer | Stop bit count for communication | - | No | 1 | 1 | 2 |
| parity | string | Communication parity option | - | No | NONE | NONE, EVEN, ODD | |
| flowcontrol | string | Communication device flow control option | - | No | NONE | ||
| serialnumber | unsigned long | Meter serial number | Yes | Yes | 1 | ||
| serial\_close\_delay | integer | Delay before closing serial port | - | No | 400 | ||
| timeout\_ms | integer | Timeout of waiting for incoming request | No | No | 2500 | ||
| type | string | Defines a connection mode | No | No | C | A,B,C | |
| t2 | integer | Time to wait before acknowledging the suggested baud rate in mode C | No | No | 300 | 200 | 1500 |
| ip | string | IP address for TCP connection | Yes | - | |||
| port | integer | TCP port | Yes | - | 0 | 65535 | |
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | ||
|---|---|---|---|---|---|---|---|
| TCP | RTU | Min | Max | ||||
| signal\_name | string | User-friendly signal name | Yes | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be use | Yes | Yes | |||
| enable | boolean | No | No | 1 | 0 | 1 | |
| log | integer | Allow signal to be logged. If **log is 0 signal** will not be logged. If **log is more than 0** signal will be logged | No | No | 0 | 0 | |
| number\_type | string | Number format type | Yes | Yes | |||
| tag\_job\_todo | string | Tag job in OBIS format | Yes | Yes | |||
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.
# 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| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used. | Yes | Elgama | ||
| device | string | Communication port | Yes | PORT1 | PORT2 | |
| baudrate | integer | Communication speed (bauds/s) | No | 9600 | 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600,115200 | |
| serial\_close\_delay | integer | Delay before closing serial port in milliseconds | No | 400 | ||
| timeout\_ms | integer | Timeout of waiting for incoming request in milliseconds | Yes | |||
| id | integer | Meter serial number | Yes | |||
| meter\_model | integer | Meter type | Yes | 0 | 4 | |
| use\_time | boolean | Use system/meter (0/1) time (Default: 0) | No | 0 | 0 | 1 |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Enable logging in event log | No | 0 | ||
| number\_type | string | Type of number (FLOAT, DOUBLE, DIGITAL, etc.) | Yes | |||
| job\_todo | string | Elgama protocol specific data set values (see files below) | Yes | |||
| tag\_job\_todo | string | Tag sub job | Yes | |||
An alias can only contain alphanumeric characters and dashes ( - and \_ ). The alias must be unique for each device.
- **protocol** - 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.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.
#### Optional settings - **enable** - Flag to enable or disable a device on the system. Can contain values 0 or 1. - **event\_history\_size** - 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. - **device** - Serial port for communication **(PORT1/PORT2)** - **baudrate** - Serial port speed. Valid values: **300**; **600**; **1200**; **2400**; **4800**; **9600**; **19200**; **38400**; **57600**; **115200** - **databits** - Number of data bits (6-9) - **stopbits** - Number of stop bits (1-2) - **parity** - Parity mode (none/even/odd) - **flowcontrol** - 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.TLS fields are only supported for IEC 61850 Client and Server, IEC-60870-5-104 Slave, and DNP3 Master and Slave, MQTT.
- **ip** - IP address for a master protocol to connect to; - **bind\_address** - one of the local IP addresses to bind the server to. Connections through other network devices will be ignored; - **host** - space-separated host IP addresses of master devices; - **port** - TCP port to listen for incoming connections; - **tls\_local\_certificate** - the name of local TLS certificate; - **tls\_peer\_certificate** - the name of a certificate authority (CA) TLS certificate; - **tls\_private\_key** - 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: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.
### `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:| Address | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 |
| Original number | Byte 0 | Byte 1 | Byte 2 | Byte 3 | Byte 4 | Byte 5 | Byte 6 | Byte 7 |
| SW8 | Byte 1 | Byte 0 | Byte 3 | Byte 2 | Byte 5 | Byte 4 | Byte 7 | Byte 6 |
| SW16 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 1 | Byte 6 | Byte 4 | Byte 5 |
| SW32 | Byte 4 | Byte 5 | Byte 6 | Byte 7 | Byte 0 | Byte 1 | Byte 2 | Byte 3 |
| SW8.SW16 | Byte 3 | Byte 2 | Byte 1 | Byte 0 | Byte 7 | Byte 6 | Byte 5 | Byte 4 |
| SW8.SW32 | Byte 5 | Byte 4 | Byte 7 | Byte 6 | Byte 1 | Byte 0 | Byte 3 | Byte 2 |
| SW8.SW16.SW32 | Byte 7 | Byte 6 | Byte 5 | Byte 4 | Byte 3 | Byte 2 | Byte 1 | Byte 0 |
Where Byte x, means bit x position in the byte.
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: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.
### 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 -> 0.003) ### Mathematical functions Table. Supported mathematical functions:| Name | Argument count | Explanation |
| sin | 1 | sine function (rad) |
| cos | 1 | cosine function (rad) |
| tan | 1 | tangent function (rad) |
| asin | 1 | arcus sine function (rad) |
| acos | 1 | arcus cosine function (rad) |
| atan | 1 | arcus tangent function (rad) |
| sinh | 1 | hyperbolic sine function |
| cosh | 1 | hyperbolic cosine |
| tanh | 1 | hyperbolic tangent function |
| asinh | 1 | hyperbolic arcus sine function |
| acosh | 1 | hyperbolic arcus tangent function |
| atanh | 1 | hyperbolic arcus tangent function |
| log2 | 1 | logarithm to the base 2 |
| log10 | 1 | logarithm to the base 10 |
| log | 1 | logarithm to base e (2.71828...) |
| ln | 1 | logarithm to base e (2.71828...) |
| exp | 1 | e raised to the power of x |
| sqrt | 1 | square root of a value |
| sign | 1 | sign function -1 if x<0; 1 if x>0 |
| rint | 1 | round to nearest integer |
| abs | 1 | absolute value |
| min | variable | min of all arguments |
| max | variable | max of all arguments |
| sum | variable | sum of all arguments |
| avg | variable | mean value of all arguments |
| floor | 1 | round down to the nearest integer |
| mod | variable | modulo operation |
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.
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.
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.
### Binary operations Table. Supported binary operators:| Operator | Description | Priority |
| = | assignment | -1 |
| » | right shift | 0 |
| « | left shift | 0 |
| & | bitwise and | 0 |
| | | bitwise or | 0 |
| && | logical and | 1 |
| || | logical or | 2 |
| <= | less or equal | 4 |
| >= | greater or equal | 4 |
| != | not equal | 4 |
| == | equal | 4 |
| > | greater than | 4 |
| < | less than | 4 |
| + | addition | 5 |
| - | subtraction | 5 |
| \* | multiplication | 6 |
| / | division | 6 |
| ^ | raise x to the power of y | 7 |
| Operator | Description | Remarks |
| ?: | if then else operator | C++ style syntax |
| Expression | Description |
| value \* 0.0001 | Multiply the tag by a constant. |
| value + TagValue(”tag/dev\_alias/sig\_alias/out”) | Add value of tag/dev\_alias/sig\_alias/out to the current tag. |
| sin(value) | Return a predefined sine function value of the tag. |
| (value>5)? 1: 0 | If the value is greater than 5, the result should be equal to 1, otherwise - equal to 0 |
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.
### 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.**Generating configuration is a resource-intensive task.** It might take up to 10 minutes depending on configuration complexity
Supported types of an Excel configuration: .xlsx, .xlsm, .xltm, .xltx
To upload an Excel file, open Protocol Hub -->Configuration 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: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.
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.Virtual device functionality is only available since firmware version v1.6.3, of WCC Lite.
### 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:*| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| description | string | Description of the device | No | |||
| device\_alias | string | Device alias to be used in the configuration | Yes | |||
| protocol | string | Selection of protocol | Yes | **Virtual device** | ||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique signal name to be used | Yes | |||
| math\_expression | string | Field to calculate specific math. You must enter the signal you want to use. | Yes | |||
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** |
| name | string | User-friendly device name | Yes | ||
| device\_alias | string | Alphanumeric string to identify a device | Yes | ||
| protocol | Protocol identifier Internal data | Yes | **Internal data** | ||
| scan\_rate\_ms | integer | Update rate | No | 60000 | |
| poll\_delay\_ms | integer | Poll delay | No | 200 |
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.
#### 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>0. When a **trigger** column is added the trigger can be changed by entering i.e. "value>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. [Excel Configuration Example](https://wiki.elseta.com/attachments/33)Digital-input GPIO will only work with Hardware versions 1.4 and above.
Certain GSM parameters will only work if a sim card is inserted.
| **job\_todo** | **Description** | **tag\_job\_todo** | **Description** |
| gpio | ReadOnly parameters | digital-input | If the value is 1 then the digital input pin is high. If it's 0 then the digital-input value is low. |
| rs232-enable | If the value is 1 then rs232 is enabled. If the value is 0 then rs485 is enabled. | ||
| Parameters that can be set. | sim-select | Switch between sim1 and sim2. If the **value** is 0 then sim1 is selected. If the value is 1 then sim2 is selected. | |
| sim-detect | Informs whether sim is inserted. | ||
| modem-reset | Making this value equal to 1 will reset the modem. | ||
| relay | Making this value equal to 1 will activate the relay. | ||
| board | Board info | cpu-usage | CPU usage % |
| ram-usage | RAM usage % | ||
| mac-address | Device MAC address | ||
| uptime | Device uptime in seconds | ||
| fw-version | Firmware version | ||
| hw-version | Hardware version | ||
| modem-imei | Modem IMEI number | ||
| modem-type | Modem type: 0 - unknown 1 - single sim 2 - dual sim | ||
| netstat|\[interface\] | Network statistics | TX | Bytes transferred |
| RX | Bytes received | ||
| led | LED status/control | blue-heartbeat | Heartbeat LED |
| blue-wlan | WLAN LED | ||
| green-eth0 | ETH0 LED | ||
| green-eth1 | ETH1 LED | ||
| green-signal1 | Signal 1 LED | ||
| green-signal2 | Signal 2 LED | ||
| green-signal3 | Signal 3 LED | ||
| red-fault | Fault LED | ||
| process | Check if the process is running | \[process name\] | 1 or 0 is returned |
| gsm | GSM information | rat-number | GSM RAT number |
| imsi-number | GSM IMSI number | ||
| internet-status | GSM Internet status | ||
| operator-number | GSM operator number | ||
| roaming-status | GSM roaming status | ||
| signal-quality | GSM signal quality | ||
| sim-status | SIM card status | ||
| date | Current set time values. | year | The current year set on the device |
| month | The current month set on the device | ||
| day | The current day set on the device | ||
| hour | The current hour set on the device | ||
| minute | The current minute set on the device | ||
| second | The current second set on the device |
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.
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.
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. [](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992159243.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 -->New --> 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.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.
[](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992239152.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). [](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: [](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: [](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1601992323578.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. Table. Mandatory parameters for Devices tab| Parameter | Type | Description |
| name | string | User-friendly device name |
| device\_alias | string | Device alias to used in configuration |
| enable | boolean | Enabling/disabling of a device |
| protocol | string | Selection of protocol (IEC 61499) |
| Parameter | Type | Description |
| signal\_name | string | User-friendly signal name |
| device\_alias | string | Device alias from a Devices tab |
| signal\_alias | string | Unique signal name to be used |
| source\_device\_alias | string | device\_alias of a source device |
| source\_signal\_alias | string | signal\_alias of a source signal |
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.
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.
Currently only PUBLISH\_1 and SUBSCRIBE\_1 function blocks are supported.
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).
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 --> Monitor System --> NewSystem). Selecting watch mode: [](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662191072.png) Function blocks in watch mode: [](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. Table. 4Diac FORTE command line debugging options: ``` -h - Display help information -cPlease note that only files with \*.fboot extension are allowed.
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.
# 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). Example blinking application as a distributed system:[](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662769321.png) Example system configuration for a distributed system:[](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662862391.png) Example app for blinking part of a distributed system:[](https://wiki.elseta.com/uploads/images/gallery/2020-10/image-1602662875556.png) Example app for counting part of a distributed system:[](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.| Name | Required | Allowed Values | Allowed Special Characters |
|---|---|---|---|
| Seconds | Y | 0-59 | , - \* / |
| Minutes | Y | 0-59 | , - \* / |
| Hours | Y | 0-23 | , - \* / |
| Day of month | Y | 1-31 | , - \* / |
| Month | Y | 0-11 or JAN-DEC | , - \* / |
| Day of week | Y | 1-7 or SUN-SAT | , - \* / |
| Year | N | empty or 1970-2099 | , - \* / |
These functions are equivalent to REDIS functions.
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 tag1These functions will require significant CPU resources even if the message log level is higher than default and no message is printed.
##### 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: [](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. [](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. [](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:| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| description | string | Description of a device | No | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | lua runner | ||
| execution\_type | string | Execution type to be used | Yes | interval, date, signal | ||
| execution\_parameter | int, string | Parameters for execution | Yes | NULL | interval time in ms, date in cron format, additional signal | |
| queue\_max | int | Maximum execution queue jobs | No | 3 | 0 to disable queue | |
| error\_limit | int | Error limit before stopping | No | 3 | 0 to disable | |
| keep\_alive\_time\_ms | int | Time to keep the script alive in milliseconds | No | 600000 | 0 to disable | |
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly name for a signal | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | Must match device\_alias in the device sheet | ||
| signal\_alias | string | Unique alphanumeric name of the signal to be Yes used | Yes | |||
| iterator | string | Lua table name to which signal is added | No | signals | ||
| default\_value | string | Default value for a signal | No | |||
| execute | int | Enable signal update trigger to execute script (only available for signal execution mode) | No | 0 | 0 | 1 |
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.
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| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| device\_alias | string | Device alias to be used in the configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 0 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | MQTT | ||
| ip | string | MQTT broker IP address/Domain name selection | Yes | |||
| port | integer | MQTT broker port selection | No | 1883 | ||
| enable\_threshold | boolean | A parameter to determine if identical values should not be sent multiple times in a row. | No | 1 | 0 | 1 |
| mqtt\_qos | integer | MQTT Quality of Service for message as in standard | No | 0 | 0 | 2 |
| mqtt\_retain | boolean | Selecting if MQTT broker should retain last received messages | No | 0 | 0 | 1 |
| user | string | MQTT user name | Yes | |||
| password | string | MQTT user password | Yes | |||
| auth | string | Selecting if TLS should be used | No | tls | ||
| ca\_certificate | string | Certificate authority file for TLS connection | Yes (If auth=tls) | |||
| client\_certificate | string | Client certificate file for TLS connection | Yes (If auth=tls) | |||
| client\_key | string | Private key that corresponds to the client certificate for TLS connection | Yes (If auth=tls) | |||
| use\_last\_will | boolean | Selecting if MQTT should use Last Will and Testament functionality (Default: False) | No | 0 | 0 | 1 |
| last\_will\_topic | string | Topic to which an MQTT message would be sent if the device abruptly disconnected message broker | Yes (If use\_last\_will=True) | |||
| last\_will\_message | string | Message to be sent over MQTT if the device abruptly disconnected message broker | No | |||
| last\_will\_qos | integer | MQTT Quality of Service selection as in standard | No | 0 | 0 | 2 |
| last\_will\_retain | boolean | Selecting if MQTT broker should retain last will message | No | 0 | 0 | 1 |
| client\_id | string | User-friendly name for client id | No | |||
| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Device alias from a Devices tab | Yes | |||
| signal\_alias | string | Unique signal name to be used | Yes | |||
| source\_device\_alias | string | device\_alias of a source device | Yes | |||
| source\_signal\_alias | string | signal\_alias of a source signal | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| log | integer | Allow signal to be logged. Log signal with 1 and no logging with 0. | No | 0 | ||
| topic | string | Topic name to override the value built by default | No | |||
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.
To launch a debugging session, a user should stop `mqtt-client` process and run `mqtt-client` command with respective flags as was shown above.
# 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.**Data export functionality is available since firmware version v1.5.0, of WCC Lite.
## 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:*| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly device name | Yes | |||
| device\_alias | string | Device alias to be used in configuration | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Selection of protocol | Yes | Data Export | ||
| timeout | integer | Time frame during which transmission to remote server has to be completed (**in seconds**) | No | 5 | ||
| type | string | Selection of file format | No | csv-simple | cvs-periodic csv-simple, json-simple, json-samples | |
| host | string | A URL of remote server where files should be sent | Yes | |||
| upload\_rate\_sec | integer | Frequency of generated file uploads (**in seconds)** | No | 60 | ||
| records\_buffer\_size | integer | A maximum amount of data change entries to hold before initiating logging mechanism | No | 100 | ||
| logging\_period\_sec | integer | Describes how frequently data buffer of records\_buffer\_size is saved to file | No | 10 | 1 | 3600 |
| log\_folder | string | A folder in WCC Lite file system to save generated file (**”/var/cache/data-export”**) | No | |||
| timestamp | string | Selection of time format | No | unixtimestamp | unixtimestamp, iso8601 | |
| compress | string | Selection of file compression mechanism | No | none | none, gz, tar.gz | |
| compress\_password | string | Enable feature of file password protection | No | yes, true | ||
| csv\_field\_separator | string | Columns separator in .csv file format | No | "," - (comma) | "," - (comma) ";" - (semicolon) "." - (dot) " " - whitespace) "|" - (pipe) | |
| csv\_decimal\_separator | string | Decimal separator in values | No | "." - (dot) | "." - (dot) "," - (comma) | |
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.
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*| **Parameter** | **Type** | **Description** | **Required | **Default value** (when not specified) | **Range** | |
| Min | Max | |||||
| device\_alias | string | Device alias to be used in configuration Yes | Yes | |||
| device\_name | string | User friendly device name as in Device sheet | Yes | |||
| tag\_name | string | User friendly signal name | Yes | |||
| source\_device\_alias | string | device\_alias of a source device | Yes | |||
| source\_signal\_alias | string | source\_alias of a source signa | Yes | |||
| enable | boolean | Enabling/disabling of a measurement to be transmitted and logged | No | 1 | 0 | 1 |
| attribute | string | Additional attribute to be attached to a signal | No | |||
The below-described parameters for debugging are accessible over console (SSH).
`-h [--help] Display help information` `-c [--config] Configuration file location` `-V [ –version ] Show version` `-dIt 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.
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.If a user intends to use newly created user account via both commandline 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.
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 DialIn 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 backend 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 -->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. *Enabled:* Enables or disables this server. *Hostname/IP:* Hostname or IP address of RADIUS server. *Timeout:* Timeout in seconds to wait for server response. *Shared* secret: Key shared between RADIUS server and RADIUS client. *Add:* Adds auxiliary (backup) server. #### Audit Log WCC Lite OS with version >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 60870510x protocol)Enabling external system log server setup in System properties --> 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.
#### 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 bruteforce 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 webServer 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 >1024): **System --> Administration -->Dropbear Instance --> Port** - public key authentication. Your public keys can be specified in **Administration --> System > SSHkeys**. 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. [](https://wiki.elseta.com/uploads/images/gallery/2023-07/image-1689335982520.png) Screen showing existing user groups[](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>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 608705 series, IEC 608706 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| **Standard** | **Description** | **Topic** | **Implemented** | **Version** |
| IEC 62351-3 | Security for any profiles including TCP/IP | TLS Encryption | Yes | >=1.3 |
| Node Authentication by means of X.509 certificates | Yes | >=1.3 | ||
| Message Authentication | Yes | >=1.3 | ||
| IEC 62351-4 | Security for any profiles including MMS | Authentication for MMS | Yes | >=1.5 |
| TLS (RFC 2246)is inserted between RFC 1006 & RFC 793 to provide transport layer security | Yes | >=1.5 | ||
| IEC 62351-5 | Security for any profiles including IEC 608705 | TLS for TCP/IP profiles and encryption for serial profiles | No | |
| IEC 62351-6 | Security for IEC 61850 profiles | VLAN use is made as mandatory for GOOSE | No | |
| RFC 2030 to be used for SNTP | No | |||
| IEC 62351-7 | Security through network and system management | Defines Management Information Base (MIBs) that are specific for the power industry, to handle network and system management through SNMP based methods | No | |
| IEC 62351-8 | Role-based access control | Covers the access control of users and automated agents to data objects in power systems by means of rolebased access control (RBAC) | Yes | >=1.2.6 |
| IEC 62351-9 | Key Management | Describes the correct and safe usage of safety-critical parameters, e.g. passwords, encryption keys. | No | |
| Covers the whole life cycle of cryptographic information (enrolment, creation, distribution, installation, usage, storage and removal) | No | |||
| Methods for algorithms using asymmetric cryptography | No | |||
| A secure distribution mechanism based on GDOI and the IKEv2 protocol is presented for the usage of symmetric keys, e.g. session keys | No | |||
| IEC 62351-10 | Security Architecture | Explanation of security architectures for the entire IT infrastructure | No | |
| Identifying critical points of the communication architecture, e.g. substation control center, substation automation | No | |||
| Appropriate mechanisms security requirements, e.g. data encryption, user authentication | No | |||
| Applicability of wellproven standards from the IT domain, e.g. VPN tunnel, secure FTP, HTTPS | No | |||
| IEC 62351-11 | Security for XML Files | Embedding of the original XML content into an XML container | No | |
| Date of issue and access control for XML data | No | |||
| X.509 signature for authenticity of XML data | No | |||
| Optional data encryption | No |
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | |
| Min | Max | |||||
| name | string | User-friendly name for a device | Yes | |||
| description | sting | Description of a device | No | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| enable | boolean | Enabling/disabling of a device | No | 1 | 0 | 1 |
| protocol | string | Protocol to be used | Yes | sms receiver | ||
| host | string | Telephone number from which to receive SMS | Yes | \[all, +37061111111\] (case-sensitive, separated by command or space) | ||
| **Parameter** | **Type** | **Description** | **Required** | **Default Value** (when not specified) | **Range** | |
| Min | Max | |||||
| signal\_name | string | User-friendly signal name | Yes | |||
| device\_alias | string | Alphanumeric string to identify a device | Yes | |||
| signal\_alias | string | Unique alphanumeric name of the signal to be Yes used | Yes | |||
| enable | boolean | Enabling/disabling of an individual signal | No | 1 | 0 | 1 |
| job\_todo | string | Choose command type | Yes | \[SIGNAL, SYSTEM\] (case-insensitive) | ||
| tag\_job\_todo | string | which command to execute (if signal, then configure the SMS) | \[REBOOT WCC, REBOOT MODEM, SWITCH SIM, SHOW IP, <CUSTOM>%F\] (case-insensitive) | |||