LKM Series Electricity Meter Protocol to Modbus Protocol Gateways with MQTT (and LoRaWAN Connectivity), 2 x 10/100Base-T(x) Ports, 1 x RS232 and 1 x RS485 Serial Ports and/or BPL (Broadband Power Line Link) User Manual

This manual describes the LKM Series gateways with firmware version 3.00.02. The firmware version, the build date and the MAC address are shown in the header of every web page, under the product name.

The LKM Series Electricity Meter Protocol to Modbus Protocol Gateways read electricity meters with the IEC 62056-21 (Mode C) and DLMS/COSEM protocols and convert the meter data to Modbus registers. A standard model reads up to 32 meters. A Lite model reads up to 10 meters. LKM615 and LKM616 read the one meter they are plugged into. The OBIS codes to read are set by the user: up to 48 OBIS codes for each meter profile ("IEC 62056-21", "Landis+Gyr DLMS", "Actaris/Itron", "Iskra DLMS", "Cewe DLMS" and "Generic DLMS"). LKM615 and LKM616 show only the "IEC 62056-21" and "Generic DLMS" profiles.

The gateway works in one of two modes, selected with "Device Function" on the "Operating Mode" page:

NOTE:

LKM615 and LKM616 offer only "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)".

In both modes the meter data can also be sent to an MQTT broker at the same time.

The REDZ Broadband Power Line (BPL) link option allows the device to communicate with full transparent TCP/IP over low voltage power lines and allows easy connection between TCP/IP based terminals without extra cables.

Typical applications: automated meter reading, telemetry, energy management.

LKM Lite models are a cost effective solution for the same tasks. A Lite model has one Ethernet port and one RS485 port, reads up to 10 meters and sends its log only to a UDP server. See 2.4 "LKM - Lite Model Differences" and chapter 20 "Product Selection".

1.1 LoRaWAN Meter Reader Models

The LKM Series 868 MHz LoRaWAN Meter Reader models (LKM354, LKM454, LKM755, LKM354-Lite and LKM616) do everything the models above do and, in addition, send the meter data to a LoRaWAN network server through a LoRaWAN gateway. The send interval is set by the user on the "LoRa Settings" page. These models have the same Modbus and MQTT settings as the other models; the LoRaWAN settings are added to them.

1.2 Direct Connection to Meter Models

LKM615 and LKM616 are designed for EMH LZQJ-XC meters and are direct replacements for Variomod XC modules. They read the EMH LZQJ-XC meter with IEC 62056-21 (Mode C) or DLMS/COSEM, convert the data to Modbus TCP and send it to an MQTT broker. LKM616 also sends the meter data to a LoRaWAN network server through a LoRaWAN gateway. On these two models a DLMS/COSEM meter is always read with the "Generic DLMS" profile.

1.3 Product names shown by the device

The web header shows the product name of the firmware in the unit. Use it to check that the unit runs the firmware of its model.

NOTE:

LKM616 and LKM354-Lite show the same product name. To tell them apart, look at the "Operating Mode" page: LKM616 has one meter row and only one "Device Function" entry, LKM354-Lite has 10 meter rows and two "Device Function" entries. LKM616 also shows only two OBIS profile tabs ("IEC 62056-21" and "Generic DLMS").

1.4 What is new in firmware 3.00.02

Firmware 3.00.02 also contains the changes of 3.00.01. The table lists the changes against 3.00.00; the full list is in 16.1 "What is new in 3.00.02 and 3.00.01".

NOTE:

An update from 2.x to 3.00.02 resets every setting to the factory settings. Read 16.6 "Upgrade from firmware 2.x" before you upgrade.

LKM Series Electricity Meter Protocol to Modbus Protocol Gateways with MQTT have versions with and without BPL (Broadband Power Line) link.

2.1 Features

• 2 x 10/100Base-T(X) ports
• 1 x RS232 and 1 x RS485 serial port
• Embedded web interface
• Reads electricity meters with IEC 62056-21 (Mode C), DLMS/COSEM, and DLMS/COSEM with IEC 62056-21 opening
• Meter side: "Start Baud Rate:" selectable from 300 to 115200 baud for each meter
• Modbus RTU side ("Serial Settings" page): "Baud rate" selectable from 300 to 460800 baud, "Line Control" 8_NONE_1, 9_NONE_1, 8_EVEN_1, 8_EVEN_2, 8_ODD_1, 8_ODD_2, 8_NONE_2 or 9_NONE_2
• 2 device functions:
  • "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)"
  • "TCP/IP Electricity Meter to Modbus RTU Gateway (and MQTT Publisher)"
• Up to 32 meters (IEC 62056-21 and DLMS/COSEM), data converted to Modbus TCP or Modbus RTU
• Up to 48 OBIS codes per meter profile, 6 profiles ("IEC 62056-21", "Landis+Gyr DLMS", "Actaris/Itron", "Iskra DLMS", "Cewe DLMS", "Generic DLMS"), all set from the web interface
• Modbus TCP server with up to 10 clients at the same time ("Maximum Number of Clients", factory setting 2)
• MQTT publisher with two data formats: "OBIS VALUES AS OBJECTS" and "OBIS VALUES AS MODBUS FRAME"
• Meter reading, Modbus communication and OBIS-to-Modbus mapping status on the web interface ("Gateway Status", "Meter Reading Status", "Device Status")
• Meter read-out data on the web interface
• DHCP server
• White list or black list IP filter with up to 20 IP addresses (in the Modbus TCP function)
• Firmware update over the web interface
• 2 firmware banks in the device (1 active); the previous firmware can be started again (see chapter 16 "Firmware Update and Upgrading")
• Configuration backup and restore as a file
• AC or DC wide range power options
• Wide operating temperature range from -25 to 70 deg C (AC power input versions, including the BPL models LKM655 and LKM755 with AC power input) and -40 to 85 deg C (DC power input versions, including LKM655-PP-DC and LKM755-PP-DC)
• Rugged metal IP-40 housing (LKM615 and LKM616: ABS housing, see 2.5 "LKM615 and LKM616 - Direct Connection to Meter Model Features")
• DIN-rail mounting (not LKM615 and LKM616)
• No battery for the clock: after a power cut set the time again, from an NTP server or with "Set Device Time"

New in firmware 3.00.02 (details in 16.1 "What is new in 3.00.02 and 3.00.01"):

• Negative meter values keep their sign (signed DLMS integer types and IEC 62056-21 values).
• A value too large for the 32-bit register gives a fixed limit value instead of a wrong number.
• Saving "Gateway Settings" no longer re-sorts the DLMS OBIS lists: unchanged codes keep their place, an unchecked code is removed and the codes after it move up.

New in firmware 3.00.01 (also in 3.00.02):

• Several IEC meters on one RS485 line: a read-out that comes from another meter than the one asked is not stored (meter identity check, see 9.1 "Scenario 1 - Meter on a direct cable, read over Modbus TCP").
• In the function "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)", an IEC session that ended without an answer is closed with the IEC break message before the next meter is asked.
• When only the MQTT broker cannot be reached, the device no longer restarts; after its DHCP refresh steps it restarts only its MQTT connection.

2.2 Extra Features for Models with LoRaWAN Meter Reader

• Radio band: EU 868 MHz (Europe), LoRaWAN RF communication
• LoRaWAN send interval set by the user ("Minimum Send Interval for a Parsed Data (in seconds)")
• Built-in LoRaWAN duty cycle check
• Built-in LoRaWAN payload size check: the device splits the data by the maximum payload size and the duty cycle block times, so the meters can be read at any interval
• "End-Device Activation Over-the-Air (OTAA)" or "End-Device Activation by Personalization (ABP)"
• User defined "LoRaWAN Port"
• "Adaptive Data Rate"
• Selectable "Uplink Data Rate"
• Selectable "Tx Power Level (EIRP)"
• "Class A" and "Class C"
• "Data Transmission without ACK" or "Data Transmission with ACK"
• Device and LoRaWAN status on the "LoRa Status" page, including the latest LoRaWAN messages

2.3 Extra Features for Models with BPL

• 2 x 10/100Base-T(X) ports + 1 x BPL link
• Wide range 3 phase AC input, 110 - 240 V, 50 - 60 Hz (versions -PN-AC and -PP-AC), or 9 - 36 V DC input (version -PP-DC)
• Three versions: -PN-AC (three-phase AC power, phase to neutral BPL data connection), -PP-AC (three-phase AC power, phase to phase BPL data connection), -PP-DC (9 - 36 V DC power, phase to phase BPL data connection); see chapter 19 "Ordering Information"
• Operating temperature from -25 to 70 deg C (AC versions) and -40 to 85 deg C (DC version)
• Up to 30 Mbps PHY rate on BPL with up to 10 hops and 1000 nodes
• Up to 432 sub-carriers from 2 to 28 MHz analog bandwidth
• LDPC-C FEC with 128-bit AES core
• Plug and play; master or node selected on the web interface ("BPL Operating Mode": "MASTER" / "NODE")

WARNING:

Connect an LKM655 or LKM755 to a network over one path only: over the power line or over an Ethernet cable. If it reaches the same network over both, the network has a loop; packets are lost and firmware uploads are cut.

2.4 LKM - Lite Model Differences

• 1 x 10/100 Ethernet port
• 1 x RS485 port; no RS232 for the meters and for the Modbus RTU output
• 9-36V DC (max 40V) power input
• No console connection for logs; the log goes to a UDP server ("Log Output": "UDP SERVER")
• Up to 10 meters (IEC 62056-21 and DLMS/COSEM), data converted to Modbus TCP or Modbus RTU

2.5 LKM615 and LKM616 - Direct Connection to Meter Model Features

• 1 x 10/100 Ethernet port
• Plug and play design for EMH LZQJ-XC meters
• Direct replacement for Variomod XC modules for EMH meters
• ABS housing, IP51, 105 x 45 x 27 mm (h x w x d)
• Gets power directly from the meter (isolated, isolation voltage up to 1500 VDC)
• Serial interface directly connected to the meter (isolated, up to 5000 VRMS isolation rating, up to 10 kVPK surge capability, overload and short-circuit protection, thermal shutdown)
• Reads 1 meter; Modbus TCP function only ("Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)"); the "Serial Settings" page is not shown
• Only the "IEC 62056-21" and "Generic DLMS" OBIS profiles; DLMS/COSEM meters are read with the "Generic DLMS" profile
• LKM616 supports LoRaWAN connectivity with the features listed in 2.2 "Extra Features for Models with LoRaWAN Meter Reader"

Each device has a Din-Rail kit on rear panel. The Din-Rail kit helps device to fix on the Din-Rail. Slant the switch and mount the metal spring to Din-Rail.

Then Push the switch toward the Din-Rail until you heard a “click” sound.

Direct Connection to Meter Models can directly fit into EMH LZQJ-XC meter. It is direct replacement for Variomod XC modules. Simply plug in LKM615 or LKM616 into meter.

4.1 LKM154 & LKM254

1. Micro USB or USB Type-C Console port for LOG in 115200 baud
   Console Tx and Rx Blink when data transmission occurs
2. Device Status LEDs
   STATUS: Blinks based on device operation
   - When TCP line used blinks during no connection and keeps ON after TCP connection
   - When Serial line used keeps ON
   Device Tx and Rx Blink when data transmission occurs
   SERVER: Keeps ON after selecting Server from Server-Client Operating Modes. Keeps OFF if Client operating mode is selected
3. ETHERNET Activity LEDs for port 1, 2 and LKM device itself. Blink during Ethernet activity
4. 5 pin Terminal Block
   RS232: Tx, Rx and GND pins
   RS485: A, B and GND pins
   Can be activated over web interface and baud rate/data type configurable
5. 10/100Base-T(X) Ethernet ports

4.2 LKM655

1. Micro USB or USB Type-C Console port for LOG in 115200 baud
   Console Tx and Rx Blink when data transmission occurs
2. Device Status LEDs
   STATUS: Blinks based on device operation
   -When TCP line used blinks during no connection and keeps ON after TCP connection
   -When Serial line used keeps ON
   Device Tx and Rx Blink when data transmission occurs
   SERVER: Keeps ON after selecting Server from Server-Client Operating Modes. Keeps OFF if Client operating mode is selected
3. ETHERNET Activity LEDs for port 1, 2 and LKM device itself. Blink during Ethernet activity
4. 5 pin Terminal Block for Serial Line
   RS232: Tx, Rx and GND pins
   RS485: A, B and GND pins
   Can be activated over web interface and baud rate/data type configurable
5. BPL Status LED
   ACTIVITY: Blinks during BPL Ethernet activity
   LINK: LED Turns ON if the link can be established over BPL
   MASTER INDICATION: LED Turns ON if the device is configured and powered as “BPL Master” device
6. 10/100Base-T(X) Ethernet ports

4.3 LKM154 - Lite

4.4 LKM354 & LKM454

1. Standard SMA female Antenna interface, 50 ohm
2. Micro USB or USB Type-C Console port for LOG in 115200 baud
   Console Tx and Rx Blink when data transmission occurs
3. Device Status LEDs
   STATUS: Blinks based on device operation
   - When TCP line used blinks during no connection and keeps ON after TCP connection
   - When Serial line used keeps ON
   Device Tx and Rx Blink when data transmission occurs
   SERVER: Keeps ON after selecting Server from Server-Client Operating Modes. Keeps OFF if Client operating mode is selected
4. ETHERNET Activity LEDs for port 1, 2 and LKM device itself. Blink during Ethernet activity
5. 5 pin Terminal Block
   RS232: Tx, Rx and GND pins
   RS485: A, B and GND pins
   Can be activated over web interface and baud rate/data type configurable
6. 10/100Base-T(X) Ethernet ports

4.5 LKM755

1. Standard SMA female Antenna interface, 50 ohm
2. Micro USB or USB Type-C Console port for LOG in 115200 baud
   Console Tx and Rx Blink when data transmission occurs
3. Device Status LEDs
   STATUS: Blinks based on device operation
   -When TCP line used blinks during no connection and keeps ON after TCP connection
   -When Serial line used keeps ON
   Device Tx and Rx Blink when data transmission occurs
   SERVER: Keeps ON after selecting Server from Server-Client Operating Modes. Keeps OFF if Client operating mode is selected
4. ETHERNET Activity LEDs for port 1, 2 and LKM device itself. Blink during Ethernet activity
5. 5 pin Terminal Block for Serial Line
   RS232: Tx, Rx and GND pins
   RS485: A, B and GND pins
   Can be activated over web interface and baud rate/data type configurable
6. BPL Status LED
   ACTIVITY: Blinks during BPL Ethernet activity
   LINK: LED Turns ON if the link can be established over BPL
   MASTER INDICATION: LED Turns ON if the device is configured and powered as “BPL Master” device
7. 10/100Base-T(X) Ethernet ports

4.6 LKM354 - Lite

4.7 LKM615

5.1 LKM154 & LKM354

5.2 LKM254 & LKM454

5.3 LKM655 & LKM755

NOTE :

Power Connection

Powering up device is only done over Terminal pins 1 and 2.

Can be purchased in 2 versions:

1. AC Powered version: Device can be powered up with AC input, this option is available in both PN and PP models. It accepts, 110V–240V/50-60Hz. (Power Input can also be used for data transmission in PN Models.)

2. DC Powered version: Device can be powered up with 9-36V DC power. Data transmission only done through terminal pins 3 and 4. This model can be used if DC power source will be used in the field and available with PP or DC model.

Data Connection

Can be purchased in 3 versions:

1. PP Model: Phase to phase model (Standard Model).

Data transmission is only done through terminal pins 3 and 4. AC Phase to phase connection should be done to data transmission pins for better performance. If phase to phase connection is not available then phase and neutral can still be connected for data transmission over terminal pins 3 and 4.

(Ex: L1-L2, L2-L3, L1-L3 or L1-2-3 to N can be used as data connection)

2. PN Model: Phase to neutral model. That version gets power from terminal pins 1 and 2 from phase and neutral and it can also transmit data from that pins (pins 1 and 2). Remaining (pins 3 and 4) pins usage is optional.

(Ex: Master can be connected to all phases and slaves can be connected to relevant phases)

(Ex: L1-N, L2-N, L3-N or L1-2-3 and N can be used as data connection)

3. DC Model: DC data line model. Uses DC Power Line for data transmission. (Ex: 24V+ and GND as data connection)

5.4 LKM154 - Lite & LKM354 - Lite

1. Power Input DC: 9-36V DC (max. 40V). Polarity protected so that the power input can be connected in any direction
2. Reset Button: Restores to Factory Default Settings.
   Reset can be done at any time by pushing the button for 5 seconds.

 

5.5 LKM615

1. 10/100Base-T(X) Ethernet port
2. Reset Button: Restores to Factory Default Settings.
   Reset can be done at any time by pushing the button for 5 seconds.

 

5.6 LKM616

1. 10/100Base-T(X) Ethernet port
2. Reset Button: Restores to Factory Default Settings.
   Reset can be done at any time by pushing the button for 5 seconds.
3. Standard SMA Antenna interface, 50 ohm

 

LKM Series Electricity Meter Protocol to Modbus Protocol Gateways with MQTT have standard Ethernet ports. According to the link type, the switches use CAT 3, 4, 5, 5e UTP cables to connect to any other network device (PCs, servers, switches, routers, or hubs).

6.1 Cable Type and Specifications

6.2 ETH Cable Pin Assignments

With 100BASE-TX/10BASE-T cable, pins 1 and 2 are used for transmitting data and pins 3 and 6 are used for receiving data.

LKM Series Electricity Meter Protocol to Modbus Protocol Gateways with MQTT have 1 x RS232 and 1 x RS485 port . The serial line can be connected to electricity meters directly or over a REDZ KMK114 RS485 Optical Probe. Both IEC 62056-21 (Mode C) and DLMS/COSEM meters are supported.

NOTE:  Lite Models have only 1 x RS485 serial port.

Direct Connected to Meter Models have no RS232 or RS485 port at all.

8.1 RS232 Cable Pin Assignments

1. Terminal connector for 3 wire Tx-Rx-GND RS232 data transmission

8.2 RS485 Cable Pin Assignments

1. Terminal Connector for 2 wire RS485 connection and GND (if needed)

LKM Series gateways can be used in many scenarios. The examples below are not the only ones; you can build your own.

A standard model reads up to 32 meters on its RS485 and RS232 ports and converts up to 48 OBIS codes of each meter to Modbus registers. The LoRaWAN Meter Reader models can also send the meter data to a LoRaWAN network server.

NOTE:

Lite models read up to 10 meters and use the RS485 port only. LKM615 and LKM616 read only the meter they are plugged into.

9.1 Scenario 1 - Meter on a direct cable, read over Modbus TCP

Select "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)". Connect the gateway to the RS485 or RS232 port of the meters. The gateway reads them with IEC 62056-21 (Mode C) or DLMS/COSEM. A local or remote data acquisition server reads the meter data over Modbus TCP.

NOTE:

Several IEC 62056-21 meters on one RS485 line: from firmware 3.00.01 the gateway checks that the read-out came from the meter it asked. Enter the meter serial number as "IEC Address:" (6 digits or more). When the read-out carries another meter identity (in OBIS 0.0.0, C.1.0 or 96.1.0), the values are not stored for that meter row and "Meter Reading Status" shows:

ID MISMATCH R:<row> got <identity in the read-out> (addr <IEC Address of the row>) - values dropped

When the read-out was complete, the reading of that row then ends with "READING FINISHED S:<s> R:<row> ERROR: ID MISMATCH". The row number counts from 1. The identity is shown as the meter sends it and can contain letters. Only the digits are compared: letters and leading zeros are ignored, and a number that is part of the other one counts as a match (for example "MSY0300270516" and "300270516"). The check is made only for rows with the protocol "IEC62056-21 (Mode C)".

NOTE:

When an IEC 62056-21 meter does not finish its session (no answer to the acknowledgement), the gateway sends the IEC break message on the same line and waits until the line is quiet for 2 seconds before it asks the next meter. "Meter Reading Status" then shows:

IEC: previous session ended without ACK - break sent, line quiet 2 s, row: <row> (n=<count>, +<lines not shown>)

<row> is the row whose session was left open. This line is shown at most once a minute; "+<lines not shown>" counts the lines left out. If the line does not become quiet within 10 seconds, the text is "IEC: previous session ended without ACK - break sent, line NOT quiet in 10 s, row: <row> (n=<count>)". For rows with the protocol "IEC62056-21 (Mode C)" the gateway waits at least 5 seconds for an answer, even when "Time Out (s):" of the row is smaller. The stored value is not changed; "Meter Reading Status" shows once for that row:

IEC: TimeoutInterval <t> s below minimum - using 5 s, row: <row>

9.2 Scenario 2 - Meter on an optical probe, read over Modbus TCP

The gateway can be connected to the optical interface of a meter and read it with IEC 62056-21 (Mode C) or DLMS/COSEM. The baud rate is changed automatically during the IEC 62056-21 opening (for "IEC62056-21 (Mode C)" and "DLMS/COSEM with IEC62056-21 Opening"). A local or remote data acquisition server reads the meter data over Modbus TCP.

9.3 Scenario 3 - Meter on the network, read over Modbus RTU

Select "TCP/IP Electricity Meter to Modbus RTU Gateway (and MQTT Publisher)". The gateway connects to TCP/IP meters ("TCP IP Address:" and "TCP Port:" of each meter row) and reads them with IEC 62056-21 (Mode C) or DLMS/COSEM. Local field devices read the meter data over Modbus RTU on the RS232 or RS485 port, set on the "Serial Settings" page.

NOTE:

In this function the "Security Settings" page (white list / black list) is not shown. Lite models give out Modbus RTU on RS485 only. LKM615 and LKM616 do not offer this function. The IEC break message and the 5 second minimum answer wait of 9.1 "Scenario 1 - Meter on a direct cable, read over Modbus TCP" do not apply to TCP/IP meters; the "Time Out (s):" value of the row is used as it is.

9.4 Scenario 4 - Meter data to an MQTT server

The gateway reads the meters with IEC 62056-21 (Mode C) or DLMS/COSEM and sends the data to an MQTT broker for web based applications.

NOTE:

The gateway can read the meters, give the data out over Modbus and send it to the MQTT broker at the same time. One gateway can serve a Modbus client and an MQTT broker together.

NOTE:

From firmware 3.00.01, when the network gateway answers but the MQTT broker cannot be reached, the gateway keeps reading the meters and keeps serving Modbus and the web interface. It does not restart the device because of the broker. When the unit is a DHCP client it first refreshes and then re-discovers its DHCP address (a re-discover can change the IP address or drop it for a moment). Then it restarts only its MQTT connection: the first time after roughly 15 to 20 minutes without delivery, then about every 5 minutes, until the broker answers again. When the network gateway itself cannot be reached, the network check of a unit in DHCP client mode can still restart the unit.

9.5 Scenario 5 - Meter data to a LoRaWAN network server

The LoRaWAN Meter Reader models read the meters with IEC 62056-21 (Mode C) or DLMS/COSEM and send the data to a LoRaWAN network server through a LoRaWAN gateway.

NOTE:

Sending data to LoRaWAN applies only to the LoRaWAN Meter Reader models (LKM354, LKM454, LKM755, LKM354-Lite and LKM616). These models have the same Modbus and MQTT settings as the other models; LoRaWAN is added to them.

9.6 Scenario 6 - LKM615 directly connected to an EMH LZQJ-XC meter

LKM615 is designed for EMH LZQJ-XC meters and is a direct replacement for Variomod XC modules. LKM615 reads the EMH LZQJ-XC meter, converts the data to Modbus TCP and sends it to an MQTT broker.

9.7 Scenario 7 - LKM616 directly connected to an EMH LZQJ-XC meter

LKM616 is designed for EMH LZQJ-XC meters and is a direct replacement for Variomod XC modules. LKM616 reads the EMH LZQJ-XC meter, converts the data to Modbus TCP and sends it to a LoRaWAN network server and to an MQTT broker.

All LKM Series gateways are configured with a web browser. This chapter describes the web interface of firmware 3.00.02, page by page, in the order of the menu on the left side of the screen.

Some pages and fields exist only on some models. The firmware of each model decides what is shown; the page does not offer settings that the model cannot use. The table below lists the differences. Model names are the names of the firmware images.

Two menu items also depend on the "Device Function" selected on the Operating Mode page:

• "Serial Settings" is shown only when "Device Function" is "TCP/IP Electricity Meter to Modbus RTU Gateway (and MQTT Publisher)".
• "Security Settings" is shown only when "Device Function" is "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)".

The menus follow the saved "Device Function" at once, also before the unit is restarted.

10.1 Connecting to the Web Interface

10.1.1 Finding the IP address

On delivery the unit is a DHCP client: it asks the DHCP server of the network for an IP address. Find the address the unit received with the abcZ Network Tool, as below.

Find the address with the abcZ Network Tool

The abcZ Network Tool lists the LKM units of a network with their address, MAC address, product and firmware version, so the unit can be found without knowing its address.

1. Connect the PC to the same network as the unit. Start the abcZ Network Tool and open the "Discovery" tab.
2. Type the network in "IP range", for example 192.168.10.0/24 for the addresses 192.168.10.1 to 192.168.10.254. Leave "User" and "Password" at the factory values (admin / admin) unless the password of the unit was changed.
3. Click "Scan (HTTP)". Each unit that answers appears as a row, with its address in "IP" and its "MAC", "Product" and "Version".
4. Find your unit by its MAC address and double-click the row: the web interface of the unit opens in the browser. The same MAC address is shown in the header of every page (10.1.3 "Screen layout").

A unit with another password is listed with "auth required (password?)": type its password and scan again. "Discover (UDP)" is a faster alternative inside the same subnet. The tool is described in full in chapter 17 "Software - abcZ Network Tool".

NOTE:

If no DHCP server answers, the unit waits about 1 minute after start-up and then works with the address stored in its configuration. On a unit with factory settings this is IP address 192.168.1.1, net mask 255.255.255.0 and DNS 192.168.1.1. Without a DHCP lease the unit uses no gateway (0.0.0.0): it can be reached only from its own subnet (for example from a PC with the address 192.168.1.10 and net mask 255.255.255.0). The unit then serves on that address and does not restart when a lease arrives later; with the lease it takes the address and the gateway given by the DHCP server. If another device on the same network already uses 192.168.1.1 (many routers do), the two addresses conflict. Connect such a unit directly to a PC, or to a network without other 192.168.1.1 devices, set a free static address or enable DHCP on the network, and save.

NOTE:

To use a fixed address, enable "Use Static Address for Device" on the Network Settings page (10.3.3 "Device Network Settings").

10.1.2 Logging in

Type the IP address of the unit into the address bar of the browser (for example http://192.168.1.50). The browser asks for a user name and a password.

The password can be changed on the Management page (10.12.4 "Change Password"). It can have up to 15 characters.

10.1.3 Screen layout

Every page has the same frame:

• Top: the product name, then "Version:", "-built:" (firmware build date and time) and "MAC:".
• Left: the menu. On a narrow screen the menu opens with the menu button at the top.
• Centre: the selected page.

When the unit still runs with factory settings, a red band under the version line says "FACTORY DEFAULTS - device is not configured". On LoRaWAN models the band adds "(factory LoRaWAN identity: address collision risk)". When only the LoRaWAN keys are still at their factory values, an orange band says "FACTORY LoRaWAN IDENTITY - DevEUI/AppKey/DevAddr still factory: two recovered devices collide". The band disappears as soon as a setting is saved (and, on LoRaWAN models, the LoRaWAN identity is set).

10.1.4 How saving works

Each settings page has a "Save Configuration" button. The button is grey until a value on the page is changed. After saving, a window shows the result:

• A confirmation in blue (for example "Network Settings Changed.") means the unit stored the settings.

• A confirmation in amber (yellow) with the line "Warning: <k> of <n> value(s) were rejected by the device and kept their previous value; the other values were saved." means that the unit did not take some of the values (for example a number outside its range). These values keep their previous setting; all other values were stored. Press "OK": the page is loaded again from the unit and shows the values it really uses. Correct the values and save again.
• When the window shows "REBOOT REQUIRED" (next point), "OK" does not reload the page.
• If the setting is used only at start-up, the window adds: "REBOOT REQUIRED: this setting is applied only at boot - the device keeps running with the previous value until you reboot it." Restart the unit with "Reboot Device" on the Management page (10.12.6 "Restore / Reboot") when all changes are done.
• If the unit restarts by itself, the window adds: "The device is restarting now - please wait."
• A red text means that nothing was saved. The reason given by the unit follows in brackets, for example "(Rejected: reboot in progress - settings NOT saved. Retry after device restarts.)".

NOTE:

Only one request runs at a time. If you press a button while another request is still running, the window "The Device is not ready, please retry later." appears. A request that gets no answer within 15 seconds ends with "Request timed out." (settings) or "Status request timed out." (status pages).

NOTE:

The page checks most values when you leave a field: a value outside the range given in this chapter is refused with a message, and the field is set back. Enter whole numbers only. A number with a decimal point (for example "502.5") is refused in the same way.

10.2 MENU: Operating Mode

This page selects what the gateway does and lists the meters it reads.

10.2.1 Device fields

10.2.2 Device Function

"Device Function" (in the "Energy Meter Connection Settings" card) has two options:

Both options read IEC 62056-21 (Mode C) and DLMS/COSEM meters. The factory setting is the serial option. EMH models (LKM615, LKM616) offer only the serial option.

10.2.3 Scheduler Settings (meter list)

The "Scheduler Settings" list has one row per meter. The number of rows depends on the model: 32 (standard, BPL and LoRaWAN models), 10 (Lite models), 1 (EMH models). The rows are loaded after the page; "Loading Scheduler Settings..." is shown meanwhile. If the list cannot be loaded, a line in red bold type on a dark background says "Meter settings could not be loaded - retrying automatically; values below are placeholders, DO NOT SAVE". Wait until the line disappears, or reload the page.

Under every enabled row a summary line shows the protocol settings of the row, for example Interface: RS485, Baud: 300, Line: 7E1, IEC Addr: 12345678, Table: 0, Send Init: 0, Init String: ABCDEFGH, Query(s): 10, Timeout(s): 10. Enabled rows are highlighted.

On a unit with factory settings, row 1 is enabled with the name "Test", protocol IEC 62056-21, RS485, start baud rate 300; all other rows are disabled.

10.2.4 Meter Protocol Settings window

The window title is "Meter Protocol Settings" with "Settings For Row: n" under it. The fields depend on "Meter Protocol" and on "Device Function":

• "IEC62056-21 (Mode C)": connection fields and IEC fields.
• "DLMS/COSEM": connection fields and DLMS fields.
• "DLMS/COSEM with IEC62056-21 Opening": connection, IEC and DLMS fields.

"Save Settings" closes the window and keeps the values on the page; the values reach the unit only with "Save Configuration". "Cancel" (or a click outside the window) discards them. Exception: a changed "IEC Meter Line Control:" is sent to the unit at once when "Save Settings" is pressed (see below).

Connection fields

NOTE:

For "IEC62056-21 (Mode C)" rows on RS232 / RS485 the unit always waits at least 5 seconds for the answer, even when "Time Out (s):" is set lower. At 300 baud the identification of the meter alone takes about 1.5 seconds. When a lower value is set, the Meter Reading Status page shows once per row: IEC: TimeoutInterval 2 s below minimum - using 5 s, row: 1. The stored value is not changed. "DLMS/COSEM" and "DLMS/COSEM with IEC62056-21 Opening" rows use the value as set.

IEC 62056-21 fields

DLMS/COSEM fields

NOTE:

The DLMS password is shown in clear text in the window and in the summary line of the row. Do not leave the page open on a shared screen.

10.2.5 Saving the Operating Mode page

Press "Save Configuration". The window "Saving Operating Mode..." stays open while the page sends the device fields and then the meter rows (two rows per request). The rows are written to the memory of the unit only with the last request, so an interrupted save leaves the stored list unchanged. At the end the window shows "Operating Mode Changed." or "Operating Mode Change Failed!" with the reason.

• Changes of the meter rows and of "Device Name" are used at once. No restart is needed, except for the network host name (10.1.4 "How saving works").
• A change of "Device Function" is used only after a restart. Until then the unit keeps working in the previous mode. The window then shows "REBOOT REQUIRED: this setting is applied only at boot - the device keeps running with the previous value until you reboot it." Restart the unit with "Reboot Device" (10.12.6 "Restore / Reboot").
• "REBOOT REQUIRED" is shown as long as the saved "Device Function" or host name differs from the one the unit runs with, also when you save the page again without a restart. When you set the value back to the running one, the note is not shown.
• If the unit did not take some values of the device fields or the meter rows, the window is shown in amber with the "Warning: ..." line (10.1.4 "How saving works").

10.3 MENU: Network Settings

This page holds the time server, the MQTT publisher and the network settings of the unit.

10.3.1 NTP Settings

How the clock is set:

• Models without LoRaWAN: after start-up the unit asks the NTP server every 10 seconds until it gets the time, then it keeps the time itself. The time is used for the "Time" field of MQTT messages.
• LoRaWAN models: the clock is kept by the LoRaWAN radio module. From 10 minutes after start-up the unit compares it with the NTP time every hour and corrects it when the difference is 5 seconds or more (no restart). The clock can also be set from the Management page (10.12.1 "Set Device Time").

10.3.2 MQTT Settings

"Enable MQTT Publisher for Enabled Obis Codes": when checked, the unit publishes the values of the enabled OBIS codes of every meter to an MQTT broker, and the following fields are shown. A worked example is given in chapter 13 "MQTT Communication Example" "MQTT Communication Example".

NOTE:

The warning windows of "Client ID", the topics and "User Name" mention "less than 33" or "less than 65" characters. The real limits are 31 and 63 characters.

NOTE:

The page holds the stored MQTT password: the eye button shows it, and it is also in the source of the page. Like the configuration file (16.7.1 "Download the configuration"), it can be read by anyone who can log in to the web interface. Protect the web password (10.12.4 "Change Password") and do not leave the page open on a shared screen.

Every message is a JSON object with these fields:

"OBIS VALUES AS OBJECTS": "Data" holds one pair per enabled OBIS code of the profile of the meter: the OBIS code and the value as text. The value "-" means that no value has been received for this code since the unit started. Otherwise the last value received is sent, also when a later reading did not deliver this code. Example:

{"LKMNme":"LKM_SERVER","Time":"1781868557","MtrAdr":"EMH IEC","MtrNmr":"1","Data":{"F.F":"-","0.9.1":"165043","1.8.0":"302367"}}

"OBIS VALUES AS MODBUS FRAME": "Data" holds one field "ModFr" with the values in hexadecimal, as in a Modbus response: the first byte is the number of data bytes, then 4 bytes (2 registers) per OBIS position, 48 positions, 192 data bytes (C0 hexadecimal). The word order follows "Modbus Word (Register) Swap" (10.6.1 "Modbus settings"); the register layout is described in chapter 11 "Modbus Register Map and Data Types" "Modbus Register Map and Data Types". Example (start of the frame): "ModFr":"C0000000000002857C..." - C0 = 192 bytes, 00000000 = position 1 (F.F, not read), 0002857C = position 2 (0.9.1 = 165244).

NOTE:

When the broker cannot be reached, the unit keeps reading meters and serving Modbus and the web pages. It restarts only its MQTT connection and tries again; the unit itself does not restart because of MQTT.

10.3.3 Device Network Settings

NOTE:

When all client places are in use, a further Modbus TCP client is refused at once (it does not hang until its own timeout). If a client closes its connection, the waiting client takes the free place.

Press "Save Configuration". The window shows "Network Settings Changed." with "REBOOT REQUIRED". The network settings, including "Server Listening Port" and "Maximum Number of Clients", are used after the next restart; until then the unit keeps the previous values.

10.4 MENU: Serial Settings

This menu is shown only when "Device Function" is "TCP/IP Electricity Meter to Modbus RTU Gateway (and MQTT Publisher)". It sets the serial port on which the unit answers Modbus RTU requests. EMH models do not have this menu.

"Baud rate" and "Line Control" are hidden while the unit does not use its serial port.

The character format of IEC meters is set in the Meter Protocol Settings window ("IEC Meter Line Control:", 10.2.4 "Meter Protocol Settings window"), not here.

Press "Save Configuration". The window shows "Serial Settings Changed.". The "RS232" / "RS485" choice is applied at once. A new "Baud rate" or "Line Control" is used only after the next restart: restart the unit with "Reboot Device" (10.12.6 "Restore / Reboot"), even if the window does not show "REBOOT REQUIRED". Save a new "Device Function" before you change the Serial Settings: while the change of "Device Function" is not saved, "Line Control" is not stored.

10.5 MENU: Device Status

This page shows the state of the unit, its counters and the state of every meter and Modbus connection. The data is read when the page opens and when "Refresh Status" is pressed. "Last update: hh:mm:ss" under the title is the time of the last read (clock of the PC).

At the top of the page, under "Last update", up to four cards give a short overview: "Meters", "Modbus TCP" (or "Modbus RTU" in the TCP/IP device function), "MQTT" and, on LoRaWAN models, "LoRaWAN". The cards are updated with every read of the page. Each card has a coloured dot before its title: green = normal, amber = needs a look, red = problem, grey = not in use or no data yet. The texts of the cards are always in the normal colours; a line that needs attention is marked with an amber bar on its left side. Read the texts; the colour is only an aid. On a narrow screen the cards are shown two per row.

Ages are shown as seconds ("s"), minutes ("min"), hours ("h", below 48 hours) or days ("d"). A meter row is named "R<row>" (its row number in the meter list of the "Operating Mode" page, which can differ from the line number of "Meter Communication Status") followed by its "Location Name or Serial Number".

NOTE:

The reading totals and ages of the "Meters" card count from the last start-up; "Reset Logs" does not reset them. The "Modbus" card takes its age from "Last Query Time", which counts within 24 hours: a last query that is older than 24 hours is shown with a shorter age.

10.5.1 Device state

10.5.2 Communication Counters

LoRaWAN models show these additional counters:

NOTE:

The LoRaWAN queue holds one message per meter row. A meter data message is built when it is sent, from the values the row has at that moment (the same values as in the Modbus registers). While it waits, new readings of that row change these values; they do not add a second message (14.5 "Messages sent to the network server").

10.5.3 Meter Communication Status

Only enabled meter rows are listed. In the TCP/IP device function an enabled row can be missing from the list for a while when the unit is opening the connection to its meter.

10.5.4 Modbus Communication Status

In the serial device function the number of rows equals "Maximum Number of Clients" (10.3.3 "Device Network Settings") as saved. After a change of this value, the table has the new number of rows when the page is loaded again, but the unit uses the new number only after the restart. In the TCP/IP device function the table has one row: the Modbus RTU line.

10.5.5 Buttons

• "Refresh Status" reads the data again without reloading the page. The button is grey while the request runs.

• "Reset Logs" sets the counters of this page to zero ("Logs have been reset."), except "N. of Modbus Incorrect Characters" and "N. of Incorrect LoRa Characters Received" (they are cleared by a restart), the last duty cycle time and the totals of the overview cards.

10.6 MENU: Gateway Settings

This page sets the Modbus address of the gateway and the OBIS codes that are read from the meters.

10.6.1 Modbus settings

10.6.2 OBIS Code Settings

The OBIS codes are kept in six profiles, one per tab: "IEC 62056-21", "Landis+Gyr DLMS", "Actaris/Itron", "Iskra DLMS", "Cewe DLMS" and "Generic DLMS". Each profile holds up to 48 codes. A meter row uses the profile of its protocol and meter type:

EMH models show only the "IEC 62056-21" and "Generic DLMS" tabs; their DLMS meters always use "Generic DLMS".

The position of a code in the profile is its position in the Modbus registers (chapter 11 "Modbus Register Map and Data Types" "Modbus Register Map and Data Types"), in the MQTT Modbus frame and in the LoRaWAN data message.

"IEC 62056-21" tab: 48 numbered boxes. Type the OBIS code as it appears in the read-out list of the meter (for example 1.8.0, F.F, C.1.0), up to 12 characters (digits, letters, ".", "*" and "("), and check the box after it to read the code. At least one code must stay enabled. The factory list starts with F.F, 0.9.1, 0.9.2, 1.8.0, 1.8.1 ... (24 codes enabled).

DLMS tabs: a list of the known OBIS codes, grouped as "Date & Time", "Device Info", "Total Energy", "Tariff Rates", "Demand", "Instantaneous" and "Other", each with a short description. Check the codes to read. The counter next to the button shows "n / 48 enabled"; more than 48 codes cannot be enabled ("Maximum 48 OBIS codes can be enabled per profile."). On saving, the stored order of the list is kept: a code that stays checked keeps its position, an unchecked code is removed and the codes after it move up one position, and newly checked codes are added at the end. The order on the screen is not the stored order; 11.7 "Default OBIS lists" explains how to read it.

"Suggest Obis Codes" fills the selected tab with the default set of codes for that meter make. The codes can then be changed one by one.

NOTE:

An easy way to match the codes to a meter is to open the unit in two browser windows: "Gateway Settings" in one, "Meter Reading Status" in the other. For IEC meters the read-out lines of the meter show which codes it sends.

10.6.3 Saving

Press "Save Configuration". The page sends the Modbus settings and the six tabs one after the other ("Saving Gateway Settings..."). The window then shows "Gateway Settings & OBIS Profiles Saved Successfully." If the unit did not take some values in any of the tabs, this window is shown in amber with the "Warning: <k> of <n> value(s) were rejected ..." line (10.1.4 "How saving works"); the numbers add up over the tabs that had a rejected value. The new codes are used from the next reading on; no restart is needed. If a tab fails, the window shows "Gateway Settings Change Failed at Tab n!".

10.7 MENU: LoRa Settings

This menu exists only on LoRaWAN models (LKM354, LKM454, LKM755, LKM354-Lite, LKM616). The values are loaded when the menu is opened. All shipped LoRaWAN models are EU868 models; this section describes the EU868 page. The LoRaWAN messages are described in chapter 14 "LoRaWAN Communication Example" "LoRaWAN Communication Example".

10.7.1 LoRaWAN Main Settings

10.7.2 Device Activation Over the Air (OTAA)

Type "Application EUI" as 16 and "Application Key" as 32 hexadecimal digits, without separators or with "-", ":" or a space between the bytes, for example "AABBCCDDEEFF1122", "0xAABBCCDDEEFF1122", "AA-BB-CC-DD-EE-FF-11-22" or "aa bb cc dd ee ff 11 22". The page shows the value as AA-BB-CC-... in capital letters. Any other entry, for example one with fewer digits, is refused with a message, for example "Application EUI should be an 8 Byte value (0xAABBCCDDEEFF1122)", and the field returns to its last saved value.

10.7.3 Device Activation By Personalization (ABP)

The two session keys are typed like the "Application Key" (10.7.2 "Device Activation Over the Air (OTAA)"): 32 hexadecimal digits, with or without separators. Any other entry is refused with a message, for example "Network Session Key should be a 16 Byte value (0xAABBCCDDEEFF1122AABBCCDDEEFF1122)", and the field returns to its last saved value.

NOTE:

The keys are shown in clear text on this page. Protect the web password (10.12.4 "Change Password").

10.7.4 Communication Settings

Factory settings: "Adaptive Data Rate" on, "Class C", "Data Transmission without ACK", 16 dBm, port 3, minimum send interval 60 s.

The unit sends a status message to port 1: device ID (4 bytes), message type 0x00, number of enabled meters, number of enabled OBIS codes of each of the six profiles, the data port, the time (4 bytes), the firmware version (3 bytes) and the "Device Name" (up to 21 bytes). With "Send OBIS Code Details as Status Message At Start" checked, one OBIS details message per profile in use follows. The message formats are described in chapter 14 "LoRaWAN Communication Example" "LoRaWAN Communication Example".

Press "Save Configuration". Of the two activation cards, only the one of the selected "Activation Method" is sent: with OTAA the "Application EUI" and "Application Key", with ABP the "Device Address", "Network Session Key" and "Application Session Key". The unit keeps its stored values of the other card. After the confirmation that card shows these stored values again; a value typed there is not saved. The window shows "LoRa Settings Changed." with "REBOOT REQUIRED". The radio settings are written to the radio module at the next start-up.

10.8 MENU: Gateway Status

This page shows the result of the last readings and the value stored for every OBIS code.

"Show OBIS Values For" selects whose values are shown: "Last Read Meter" (default) or "Meter 1" ... "Meter n". Press "Set Show Meter Value" to apply the choice; the window "Gateway Status Show Meter Value Changed." confirms it. The choice is not stored and returns to "Last Read Meter" after a restart. EMH models do not have this selector.

"Reading OBIS Details" lists the codes of the profile of the selected meter, each with its value. A received value is shown in green bold type on a dark background; "N.A." and "-" are shown in normal type. The colour is only an aid; read the value. "N.A." means the code is not enabled. "-" means that no value has been received for this code since the unit started. Otherwise the last value received is shown, also when a later reading did not deliver this code; check "Meter Reading Status" (10.10 "MENU: Meter Reading Status") to see what the last reading returned.

"Refresh Gateway Status" reads the data again without reloading the page. The time of the read is shown as "Last update: hh:mm:ss".

10.9 MENU: LoRa Status

This menu exists only on LoRaWAN models. It shows the state of the LoRaWAN connection and the last messages. "Refresh LoRa Status" reads the data again; the time of the read is shown as "Last update: hh:mm:ss". A read of the "Device Status" page also reads this page again.

"LoRaWAN Network Status":

"Latest Tx Message Info (LoRa Side)": "Device Time" (time of the last uplink), "Channel", "Data Rate", "Nu. Of Transmitted Packages" (radio packets used for the message), "Transmit Power Level (dBm)", "RF Msg. Air Time (ms)".

"Latest Rx Message Info (LoRa Side)": "Device Time" (time of the last downlink), "Channel", "Data Rate", "RSSI (dBm)", "SNR (dB)", "RxSlot".

The values of "RSSI (dBm)" and "SNR (dB)" are shown in bold type on a dark background, in a colour that depends on the value:

When no value has been received, the field is shown in normal type. The value text and its colour show the same thing; read the number.

"Latest Rx - No Data Info (LoRa Side)": "No Data Received Counter" (receive windows without data) and, when the radio module reports one, "Error Code": "Wrong MType received", "Wrong Device Address received", "Wrong MIC received", "Unexpected FCnt received", "Wrong MAC commands received", "Wrong downlink received" or "Expected ACK missing".

"Latest LoRaWAN Message Sent": "Device Time", "Payload in Hex" and "Payload As ASCII" of the last message the unit sent (non-printable bytes shown as ".").

"Message Details - LoRa Side (debug)" is closed by default; click its title to open it. It shows the last message exchanged with the radio module ("Message Type", for example "SEND_UDATA_TX_IND", "RECV_UDATA_IND", "JOIN_NETWORK_IND", "OTAA_JOIN_NETWORK_RSP", "ABP_ACTIVATE_DEVICE_RSP", "RECV_NO_DATA_IND", "GET_NWK_STATUS_RSP") and its payload. This part is meant for REDZ support.

10.10 MENU: Meter Reading Status

This page shows the last 210 lines of the meter communication: the data received from IEC meters and the messages of the unit about the readings. It is the first place to look when values are missing. The lines are arranged in three columns, "Oldest -> newest, top to bottom per column". "Refresh Meter Reading Status" reads the lines again; the time of the read is shown as "Last update: hh:mm:ss".

Some lines are shown in colour, in bold type on a dark background. The page checks each line in this order and uses the first rule that fits:

The texts must match exactly, including upper and lower case. All other lines are shown in the normal colour and type.

In the table of 10.10.2 "Messages of the unit" these messages are therefore shown in red: "READING FINISHED ... ERROR: ...", "DLMS LOGIN REJECTED", all "A3: ..." lines, the "BE: ..." lines, "ID MISMATCH ...", both "IEC: previous session ended without ACK ..." lines, "IEC: TimeoutInterval ...", "<OBIS code>, ERROR_..." lines, "PDU SERVICE_ERROR", "No OBIS in profile - check GatewaySettings tab", "dlms_parse_object_list_extract found no data", "DATA reassembly overflow: n", "hdlc_parse_response_pdu status: n" and "dlms_parse_get_response_normal_pdu status: n". "DLMS LOGIN OK ...", "Updated OBIS ...", the DLMS value lines, "HDLC DISCONNECTING..." and "DLMS DISCONNECT OK" are shown in the normal colour.

NOTE:

The colour is only an aid. Always read the text of the lines (table in 10.10.2 "Messages of the unit"): a successful reading ends with "READING FINISHED S:<s> R:<row>" after the read-out lines of the meter; a failed reading ends with "READING FINISHED S:<s> R:<row> ERROR: <reason>". A red line is not always a fault that needs action; for example "IEC: TimeoutInterval ..." only reports that the unit uses 5 s.

10.10.1 Lines of the meter

For "IEC62056-21 (Mode C)" rows, the lines received from the meter are shown as they arrive, for example the IEC identification line (it starts with "/") and read-out lines such as 1.8.0(000302.367*kWh). The read-out ends with the line "!"; the check character (BCC) that the meter sends after it is not shown. If a reading of such a row shows no meter lines at all, the meter did not answer; the reading then ends with "READING FINISHED S:<s> R:<row> ERROR: Timeout WAIT_FOR_ACK".

For "DLMS/COSEM" and "DLMS/COSEM with IEC62056-21 Opening" rows the raw data of the meter is not shown; only the messages of the unit (table below) appear, including one value line per OBIS code read.

10.10.2 Messages of the unit

NOTE:

To get the protection of the ID check, enter the meter serial number (as the meter reports it in 0.0.0 or C.1.0) as "IEC Address:" of every IEC row on a shared RS485 line.

10.11 MENU: Security Settings

This menu is shown only when "Device Function" is "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)". It filters the Modbus TCP clients by IP address.

Only one list can be active; checking one unchecks the other. Press "Save Configuration". The window shows "Security Settings Changed."; the filter is applied at once to every connection opened after the save. A client that is already connected stays connected until it closes its connection.

10.12 MENU: Management

This page sets the clock, updates the firmware, saves and restores the configuration, changes the password and the log settings, and restarts the unit.

10.12.1 Set Device Time

"Time At Start" shows the clock of the unit when the page was loaded; "Current Local Time" shows the clock of the PC. Press "Set Device Time" to copy the PC time into the unit. The window "Device time has been set." confirms it. The unit does not restart when the time is set.

NOTE:

The NTP server (10.3.1 "NTP Settings") sets the clock automatically when the unit can reach it.

10.12.2 Live Firmware Update

The unit keeps two firmware images: the running one and an alternative one. "Select Firmware File" and "Upload Firmware" load a new firmware file (name ending in .binimg, for example LKM154-254_v3.00.02.binimg) into the place of the alternative image; "Alternative Firmware Date" and "Alternative Firmware Version" then show it. "Reboot Alternative Firmware" restarts the unit with the alternative image. The complete procedure is described in chapter 16 "Firmware Update and Upgrading" "Firmware Update and Upgrading". REDZ recommends the abcZ Network Tool for firmware updates (chapter 17 "Software - abcZ Network Tool").

WARNING:

Use the firmware file whose file name matches your model. The unit itself only refuses a file of the other key group ("Error: Firmware Does not Match With Device."); a file of another model in the same group is accepted and installed. | Key group | Models | |---|---| | Group 1 | LKM154 / LKM254, LKM655, LKM354 / LKM454, LKM755 | | Group 2 | LKM154-Lite, LKM615, LKM354-Lite, LKM616 |

NOTE:

The settings are kept when the first two numbers of the version are equal (for example 3.00.01 to 3.00.02). Otherwise (for example 2.07.x to 3.00.x) the unit starts with factory settings. Download the configuration (10.12.3 "Download / Upload Configuration") before an update.

10.12.3 Download / Upload Configuration

"Download Current Configuration" saves the complete configuration of the unit to a file named ZTG_<Device Name>_v<version>.zcfg (for example ZTG_LKM_SERVER_v3.00.02.zcfg).

WARNING:

The downloaded configuration file contains the web password, the MQTT password, the DLMS passwords and the LoRaWAN keys in clear text. Keep the file private: store it in a protected place and do not send it by e-mail or share it with persons who must not have access to the unit.

"Upload Configuration File" opens a file dialog. Choose a .zcfg file; the upload starts at once. The window shows the answer of the unit:

A meter row value in the file that the unit cannot use is replaced by its factory value (16.7.2 "Upload a configuration").

10.12.4 Change Password

Enter "Current Password", "New Password" and "Confirm New Password" (up to 15 characters). The "Change Password" button is enabled when all three fields are filled and the two new entries match. After "Change Password" the window says "Password Changed, Next time you login, please use new password." The user name stays "admin". Possible refusals: "Rejected: current password is incorrect - password NOT changed", "Rejected: new password and confirmation do not match - password NOT changed".

10.12.5 LOG

The unit can send a log of its operation for diagnosis.

Press "Change Log Level and Reboot". If a log setting changed, the unit restarts ("Rebooting..."); otherwise the window says "Log settings unchanged - no reboot needed." Any UDP receiver program can show the log sent to a UDP server. How to read the log: see chapter 18 "Logs and Troubleshooting".

With "INFO" the unit sends its start-up messages; a meter reading without errors adds no line. "DEBUG" shows every step of a meter reading, as in the picture.

10.12.6 Restore / Reboot

After the confirmation a window with a progress bar shows "Rebooting..."; the page reloads after about 5 seconds. After a factory restore the unit may get another IP address (10.1.1 "Finding the IP address").

NOTE:

The unit restarts itself once every 24 hours of operation. This is planned; the settings are kept and the meters are read again right after the start.

This chapter describes the Modbus registers of the LKM Series gateways with firmware 3.00.02. It is valid for all models; model differences are named where they exist. A worked example is in chapter 12 "Modbus Communication Example".

11.1 Protocol summary

11.2 Modbus TCP server

Available when "Device Function" is "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)".

11.3 Modbus RTU slave

Available when "Device Function" is "TCP/IP Electricity Meter to Modbus RTU Gateway (and MQTT Publisher)" (not on LKM615 / LKM616). The meters are then read over TCP/IP and the serial port is the Modbus RTU slave.

NOTE:

On a shared RS485 line the gateway ignores all frames that carry another slave address (also address 0). They are not counted in "N. of Modbus Incorrect Characters" or "N. of Modbus Messages Received Correctly" on the "Device Status" page. With "Log Level" INFO or DEBUG the log shows once after each start-up a line with the text "RTU: frames for other slave ids ignored, first id: <n>"; <n> is the slave address of the first such frame.

NOTE:

Frames for the gateway's own address that are faulty (wrong CRC, other function code, invalid register request) are counted. A request with a correct CRC that asks for an odd number of registers or for more than 125 registers is counted in "N. of Modbus Incorrect Characters", but not in this count: it gets no answer, does not lead to a restart and does not start the count again. Every valid request starts this count again. When more than 500 such characters arrive without a valid request in between, the gateway restarts (log line "Serial INC CHARS RESTART"). This happens at most twice in a row: the third time it does not restart, and "App Status" shows "(SERIAL NOISE PARKED - check line/baud)" until a valid request arrives. Check the wiring, the baud rate and the "Line Control" of the master.

11.4 Address rule

address = (meter row - 1) x 256 + 2 x OBIS index

• meter row: 1 to 32 (1 to 10 on Lite, 1 on EMH), as in the "Scheduler Settings" table,
• OBIS index: 0 to 47, the position of the code in the OBIS list of the meter's profile (11.7 "Default OBIS lists").

Holding register numbers used by tools with 1-based addressing (4xxxx) are address + 40001. A request never crosses into the next row: each row needs its own request.

NOTE:

Ask for an even number of registers that ends at or before index 47. A request for one register (an odd number) gets no answer, because every value takes two registers. Many Modbus masters reject an answer whose length differs from the request, so do not rely on the past-index-47 behaviour above. With "Log Level" DEBUG the log shows a line "MODBUS WRONG Req. register count: <n>" for each request with an odd quantity or a quantity larger than 125; <n> is the quantity asked.

11.5 Data types and value conversion

Every value is a 32-bit integer made from the text value the gateway stored for that OBIS code:

1. the characters ".", ",", ":" and space are removed,
2. the remaining text is converted to an integer: an optional "-" at the start, then the digits up to the first character that is not a digit,
3. if the text contains "-" the value is a signed 32-bit integer (two's complement), otherwise unsigned.

A value that does not fit into 32 bits gives a limit value: an unsigned value above 4294967295 gives 4294967295 (0xFFFFFFFF), a negative value below -2147483648 gives -2147483648 (0x80000000). A limit value is not a reading.

The register itself does not say whether it is signed. Read a register that cannot be negative (for example energy) as unsigned 32-bit, and a register that can be negative (for example power with direction) as signed 32-bit.

The stored text depends on the meter protocol:

IEC 62056-21 meters. Only the digits between "(" and ")" (or "*") of the readout line are stored, with a minus sign when it is the first character of the value; leading zeros, the decimal separator, the unit, letters (also the letters of a hexadecimal value) and every other minus sign (for example in a date) are dropped. A value without any digit is stored as 0.

The scale is the number of decimals the meter shows; the gateway does not send it.

DLMS/COSEM meters. The type follows from the OBIS code:

NOTE:

The DLMS scaler of the object is not applied. A register value of 12041000 means a raw meter value of 12041; the unit and the scaler (10^n) of that object come from the meter's documentation.

NOTE:

Large DLMS values. Because the register holds raw value x 1000, a raw value from 0 to 4294967.295 fits (as unsigned), and a negative raw value down to -2147483.648 (as signed). Above that the register holds the limit value 4294967295 (0xFFFFFFFF), below it -2147483648 (0x80000000), for example for an energy register in Wh above 4294 kWh. The same applies to the MQTT data format "OBIS VALUES AS MODBUS FRAME" and to LoRaWAN. For such registers use the MQTT data format "OBIS VALUES AS OBJECTS" (chapter 13 "MQTT Communication Example") or the "Gateway Status" page: they show the stored value as text (e.g. "5500123.000").

NOTE:

Negative DLMS values. The signed types of DLMS (integer, long, double-long, long64) and the float types arrive with their sign: a long of -5 gives -5000 (0xFFFFEC78, signed 32-bit), a float of -5.0 also gives -5000. The same applies to MQTT and LoRaWAN.

The clock value includes the time zone deviation sent by the meter.

11.6 Value states

There is no status register and no time stamp register.

11.7 Default OBIS lists

Every meter row uses the OBIS list of one profile:

NOTE:

For the DLMS profiles the OBIS index is the position of the code in the stored list. A "Save Configuration" on the "Gateway Settings" page keeps this order: - a code that stays checked keeps its index, - a code that you uncheck is removed, and the codes after it move up one index (index - 1, their address goes down by 2), - a code that you check is added at the end of the list (several new codes in the order of the page), - a code that you uncheck and check again before you save keeps its index. On a unit with factory settings the indexes are the factory indexes of the tables below. The order of the codes on the "Gateway Settings" page is not the stored order. Read the register order from the unit after every change of a DLMS list: on the "Gateway Status" page "Reading OBIS Details" lists the codes in index order (empty positions are skipped). Plan the Modbus master (and the decoding of the MQTT Modbus frame and of LoRaWAN) from that list. After a save that moved codes, a register shows the value of its new code only after the next reading of that meter row.

NOTE:

Units that were saved with firmware 3.00.00 or 3.00.01. These firmware versions stored every DLMS list again in the order of the page at each save of "Gateway Settings" (grouped as "Date & Time", "Device Info", "Total Energy", "Tariff Rates", "Demand", "Instantaneous"). A unit whose "Gateway Settings" were saved with them keeps that order after the update to 3.00.02; the order is not changed back. For such a unit, with the factory lists, the columns "Index after a save with 3.00.00 / 3.00.01" of the tables below apply. The first index that moved: | Profile | First index that moved at the first save with 3.00.00 / 3.00.01 | |---|---| | IEC 62056-21 | none (the order is never changed) | | Landis+Gyr DLMS | 34 | | Actaris/Itron | 12 | | Iskra DLMS, Cewe DLMS, Generic DLMS | 28 |

The IEC 62056-21 list keeps its order: each of the 48 positions is a text field on the page.

Addresses below are for row 1. For row n add (n - 1) x 256.

11.7.1 IEC 62056-21 profile (meters with "Meter Protocol" IEC 62056-21)

11.7.2 Landis+Gyr DLMS profile

11.7.3 Actaris/Itron profile

11.7.4 Iskra DLMS, Cewe DLMS and Generic DLMS profiles (the three lists are the same)

11.8 The same values over MQTT and LoRaWAN

The MQTT data format "OBIS VALUES AS MODBUS FRAME" and the LoRaWAN meter data message carry the same 32-bit values in the same word order ("Modbus Word (Register) Swap" applies). The MQTT frame always carries all 48 indexes; the LoRaWAN message carries the enabled codes only. See chapter 13 "MQTT Communication Example" and chapter 14 "LoRaWAN Communication Example".

11.9 Example: reading row 2, three values

Row 2, factory IEC list, values "1.8.0" (index 3), "1.8.1" (index 4) and "1.8.2" (index 5):

• start address = 1 x 256 + 2 x 3 = 262 (0x0106), holding register 40263,
• quantity = 3 x 2 = 6 registers.

Example request (Modbus TCP, transaction 5, "Gateway Modbus Address" 1):

00 05  00 00  00 06  01  03  01 06  00 06

The answer has the form of 12.3 "Reading with function code 3 (example)": length field 00 0F, byte count 0C (12), then three 4-byte values.

The gateway reads IEC 62056-21 (mode C) and DLMS/COSEM electricity meters and keeps the values of up to 48 OBIS codes for every meter row. A Modbus master reads these values with function code 3 (Read Holding Registers).

The "Device Function" on the "Operating Mode" page decides which Modbus side the gateway has:

Number of meter rows: 32 on the standard and LoRaWAN models, 10 on the Lite models (LKM154-Lite, LKM354-Lite), 1 on the EMH models (LKM615, LKM616). On the Lite models the meters are read over RS485 only (no RS232). The EMH models offer only the first device function.

NOTE:

The full register map (address rule, data types, default OBIS lists of every profile) is in chapter 11 "Modbus Register Map and Data Types" "Modbus Register Map and Data Types". This chapter shows a worked example.

12.1 Modbus settings

On the "Gateway Settings" page:

Use an address from 1 to 247. The page refuses another value ("Modbus Address should be a number between 1 and 247"), and the gateway keeps its previous address. Set the Unit ID (slave ID) of your Modbus master to the same number: a master that sends Unit ID 0 or 255 gets no answer.

On the "Network Settings" page (Modbus TCP server only):

Changes on "Gateway Settings" (address, swap, OBIS codes) and the meter list are applied at once. Changes on "Network Settings" take effect after a restart ("Management" > "Reboot Device").

NOTE:

When all client places are in use, a further master is not left waiting: its connection is accepted and, if no place becomes free within about 0.25 s, closed at once (TCP reset). The device log shows "TCP client refused - all client slots in use" (for the first three refusals and then for every 100th). Set "Maximum Number of Clients" to the number of masters that read the gateway.

12.2 Register addresses

The register address carries the meter row and the OBIS index:

• high byte = meter row - 1 (row 1 = 0x00xx, row 2 = 0x01xx, ... row 32 = 0x1Fxx),
• low byte = 2 x OBIS index (OBIS index 0 to 47, the position of the code in the OBIS list of the meter's profile, see 11.7 "Default OBIS lists").

Every value takes 2 registers (32 bits). The start address must be even.

A row is answered only while it is enabled in the meter list. All rows can be read by one master or by several masters at the same time.

12.3 Reading with function code 3 (example)

Example request: read 8 registers (4 values: "1.8.0", "1.8.1", "1.8.2", "1.8.3") of row 1 from a gateway with "Gateway Modbus Address" 1:

00 01  00 00  00 06  01  03  00 06  00 08

Example answer, with the readout lines 1.8.0(302.367*kWh), 1.8.1(180.120*kWh), 1.8.2(097.512*kWh), 1.8.3(024.735*kWh):

00 01  00 00  00 13  01  03  10  00 04 9D 1F  00 02 BF 98  00 01 7C E8  00 00 60 9F

With "Modbus Word (Register) Swap" on, the same values come as 9D 1F 00 04 BF 98 00 02 7C E8 00 01 60 9F 00 00.

The same values of row 2: start address 01 06.

12.4 How a value is converted

IEC 62056-21 meters: the gateway takes the digits between the brackets of the readout line and drops the decimal separator, leading zeros, the unit and every other character (also letters, so a hexadecimal value cannot be read). A minus sign at the start of the value is kept: the value is then negative.

The number of decimals is the one the meter shows. Your Modbus application applies the scale (here / 1000). You can compare the values with the "Gateway Status" page.

NOTE:

A minus sign inside a value (for example in a date such as 0.9.2(26-10-16)) is dropped; only a minus sign at the start of the value makes it negative.

DLMS/COSEM meters: the register holds the raw meter value x 1000 (the gateway keeps three decimals and removes the decimal point). The scaler of the meter object is not applied. The clock object ("0.0.1.0.0.255") arrives as a Unix time stamp (seconds), the serial number as its digits. Negative values (signed DLMS integer types and float types) keep their sign.

NOTE:

Limits of the 32-bit register: - IEC 62056-21 values: the digits without the decimal separator must fit in 32 bits. A larger value gives the limit value 4294967295 (0xFFFFFFFF), a larger negative value the limit value -2147483648 (0x80000000). - DLMS values: a raw value from 0 to 4294967.295 fits as an unsigned 32-bit value, a negative raw value down to -2147483.648 as a signed 32-bit value. A larger value gives the limit value 4294967295 (0xFFFFFFFF), a smaller negative value the limit value -2147483648 (0x80000000). A register at a limit value may be out of range. This is the case, for example, for an energy register in Wh above 4294 kWh. For such registers use the MQTT data format "OBIS VALUES AS OBJECTS" (chapter 13 "MQTT Communication Example") or the "Gateway Status" page: they show the full value as text. - Read a register that cannot be negative (for example energy) as unsigned 32-bit, and a register that can be negative (for example power with direction) as signed 32-bit.

See chapter 11 "Modbus Register Map and Data Types" "Modbus Register Map and Data Types" for the details.

12.5 What the master gets when something is missing

The gateway sends no Modbus exception responses. It does not answer when:

• the function code is not 3,
• the unit ID / slave address is not the "Gateway Modbus Address",
• the start address is odd or its low byte is 96 (0x60) or more,
• the row (high byte) is not enabled in the meter list,
• the number of registers is 0, odd (for example 1) or larger than 125,
• (Modbus TCP) the protocol identifier is not 0 or the length field is not 6,
• (Modbus RTU) the CRC is wrong.

Set the master's timeout and treat a missing answer as an error.

NOTE:

The registers carry no time stamp or quality flag. To see when a row was read last, use the "Device Status" page ("Last Query Time" in "Meter Communication Status").

NOTE:

Always ask for an even number of registers that ends at or before OBIS index 47. An odd number gets no answer; a request that runs past index 47 is answered only up to index 47. Many Modbus masters reject an answer whose length differs from the request.

12.6 Example: three meters, read with a Modbus TCP master

12.6.1 Step 1 - Enter the meters

On the "Operating Mode" page enter the meters in the "Scheduler Settings" table and check "Enable" for each row. In this example (the same data set is used in chapter 11 "Modbus Register Map and Data Types", chapter 13 "MQTT Communication Example" and chapter 14 "LoRaWAN Communication Example"):

• row 1: meter ELM82733811 on the RS232 port, "Serial Interface:" RS232, "Start Baud Rate:" 300, "Location Name or Serial Number" ELM82733811,
• rows 2 and 3: two meters on one RS485 line, "Serial Interface:" RS485, "IEC Address:" 5061905 and 5061906.

Click "Save Configuration". The meter list is applied without a restart.

NOTE:

When several meters share one RS485 line, enter the meter address (serial number) in every row. The gateway checks that the answer comes from the addressed meter (see "ID MISMATCH" in chapter 10 "Configuration via WEB Interface").

12.6.2 Step 2 - Check the readings

Open "Device Status" and check "Last Serial Package" and "Status" in "Meter Communication Status".

Open "Meter Reading Status" and check that the reading of each row ends with "READING FINISHED S:<s> R:<row>" without "ERROR".

12.6.3 Step 3 - Choose the OBIS codes

Open "Gateway Settings". Adapt the OBIS codes of the IEC 62056-21 tab to the readout of your meters and click "Save Configuration". In this example the factory list (24 enabled codes) is kept.

12.6.4 Step 4 - Check the values on the gateway

Open "Gateway Status", select the meter in "Show OBIS Values For", click "Set Show Meter Value" and check the values in "Reading OBIS Details".

12.6.5 Step 5 - Read the registers

Connect the Modbus TCP master to the gateway's IP address and "Server Listening Port" (502). Create one read per meter:

Set the display of the master to 32-bit integer, big-endian (or word swapped if "Modbus Word (Register) Swap" is on).

NOTE:

In Modbus Poll (version 5.0.1) the display depends on "Modbus Word (Register) Swap" on the "Gateway Settings" page: not checked (factory setting) - "Long Inverse"; checked - "Long". With the other one the two halves of each value are swapped.

In both device functions the gateway can publish the meter values to an MQTT broker at the same time as it serves them over Modbus (and, on the LoRaWAN models, over LoRaWAN). One message is published per meter row after a successful reading.

13.1 MQTT settings

Go to "Network Settings" and check "Enable MQTT Publisher for Enabled Obis Codes". The fields:

The field shows the stored password as dots; the eye button at the right end of the field shows or hides it (10.3.2 "MQTT Settings"). Type a new password to replace it; a field left empty returns to the stored password.

Click "Save Configuration", then restart the gateway ("Management" > "Reboot Device"). The MQTT settings take effect after the restart.

NOTE:

The gateway connects with plain MQTT over TCP only (no TLS encryption). Use the plain MQTT port of your broker, normally 1883.

Connection details: MQTT 3.1.1, QoS 0, clean session, no retained messages, keep-alive 120 s. The user name and password are always sent.

13.2 Message format "OBIS VALUES AS OBJECTS"

Topic: "Publish Topic". Payload: one JSON object per meter row. Example for row 1 of 12.6 "Example: three meters, read with a Modbus TCP master" (factory IEC list, 24 enabled codes):

{"LKMNme":"LKM_SERVER","Time":"1792146600","MtrAdr":"ELM82733811","MtrNmr":"1","Data":{"F.F":"0","0.9.1":"102947","0.9.2":"261016","1.8.0":"302367","1.8.1":"180120","1.8.2":"97512","1.8.3":"24735","2.8.0":"12400","2.8.1":"8100","2.8.2":"4300","2.8.3":"0","5.8.0":"58000","6.8.0":"1250","7.8.0":"840","8.8.0":"21300","1.6.0":"1250","2.6.0":"430","32.7.0":"2301","52.7.0":"2298","72.7.0":"2310","31.7.0":"520","51.7.0":"485","71.7.0":"502","C.1.0":"82733811"}}

The value text is the stored value: for IEC 62056-21 meters the digits of the readout value without decimal separator ("302.367" -> "302367"), with a leading "-" for a negative value; for DLMS meters the raw value with three decimals ("12041.000", with a leading "-" for a negative value of a signed type), the clock as Unix time and the serial number as text (see chapter 11 "Modbus Register Map and Data Types" "Modbus Register Map and Data Types"). This format is not limited to 32 bits: use it for DLMS values that are too large for a Modbus register (11.5 "Data types and value conversion").

A message is at most 2700 bytes. If the enabled codes do not fit, the list is cut, the JSON stays valid and the device log shows "MQTT message size limit - OBIS list cut at index: n".

Quotes and backslashes in the device name or location name are escaped, so the payload is always valid JSON.

13.3 Message format "OBIS VALUES AS MODBUS FRAME"

The keys are the same; "Data" holds one key "ModFr" with a hex string: one byte count (C0 = 192), then all 48 values of the row as 32-bit integers in OBIS index order (4 bytes each). It is the data part of a Modbus answer for start address 0, 96 registers. A disabled code gives 0, or the last value read before it was disabled. Example for the same row:

{"LKMNme":"LKM_SERVER","Time":"1792146600","MtrAdr":"ELM82733811","MtrNmr":"1","Data":{"ModFr":"C000000000000192230003FB9800049D1F0002BF9800017CE80000609F0000307000001FA4000010CC000000000000E290000004E20000034800005334000004E2000001AE000008FD000008FA0000090600000208000001E5000001F604EE6AF3000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"}}

"Modbus Word (Register) Swap" changes the word order here too. The conversion and the 32-bit limits of 11.5 "Data types and value conversion" apply (signed and unsigned values, limit values for values that do not fit).

13.4 When messages are sent, and what happens without a broker

• A message of a meter row is prepared after every successful reading of that row. It is published when "Minimum Send Interval for a Parsed Data (in seconds)" has passed since the last message of the same row. It carries the values at the time it is sent. Readings in between are not queued: the broker gets the latest values, not every reading.
• A reading that fails, or that ends with "ID MISMATCH", produces no message.

When the broker cannot be reached:

• the gateway tries to connect again, at most once every 5 seconds,
• about 18 minutes after the last delivery to the broker the gateway restarts its MQTT client, and then about every 5 minutes while the broker stays unreachable (as a DHCP client the gateway first renews its DHCP address; with a fixed IP address the timing is the same),
• the gateway does not restart because of MQTT. Meter reading, Modbus and the web pages keep working.

Messages that could not be sent are not stored: when the broker is back, each row sends its latest values.

NOTE:

A separate network watchdog checks the router (network gateway) of a gateway that gets its address by DHCP. If the router itself stops answering, this watchdog renews the address and, as the last step, restarts the unit. This is not caused by MQTT.

The "Device Status" page shows "MQTT Sent Messages" and "MQTT Status". While the gateway is connected the status is APP_MQTT_STATE_SUBSCRIBED or one of the publish / wait states that follow it (10.5.2 "Communication Counters"). The "MQTT" card at the top of the page shows "Connected" or "Not connected" in short (10.5 "MENU: Device Status").

13.5 Subscribe topic: configuration over MQTT

The gateway subscribes to "Subscribe Topic". A message on this topic is taken as a part of a configuration file (the same file as the configuration export of the "Management" page). Each part has the form <total length>, <position>, <length>, "<data>. After each part the gateway publishes an answer on the fixed topic MQTT_LKM_Conf_Ack_topic, for example:

{ "variable": "conf_upd_ack","value": "started","metadata": {"mqtt_topic": "MQTT_LKM_Conf_Ack_topic", "result": "OK", "position": 0, "length": 512, "response": "Configuration Uploaded", "response_1": "" }}

A complete file is stored and the gateway restarts. Meter row values that the unit cannot use are replaced by their factory value, as for an upload on the "Management" page (16.7.2 "Upload a configuration"). Parts out of order are rejected ("result": "error").

NOTE:

Anyone who can publish on the "Subscribe Topic" of your broker can change the gateway configuration. Use a broker with user accounts and topic rights, and a subscribe topic that only your system can write.

13.6 Example with TagoIO

1. Enter the meters and check the readings (12.6 "Example: three meters, read with a Modbus TCP master", steps 1 to 4).
2. In the TagoIO panel click "Add Device", choose "Custom MQTT", enter a device name and click "Create My Device". Copy the token of the new device.
3. On the gateway: "Network Settings" > "Enable MQTT Publisher for Enabled Obis Codes". "MQTT Broker IP or URL": mqtt.tago.io, "MQTT Broker Port": 1883, "Password": the token. Choose the "Data Format".
4. Click "Save Configuration" and restart the gateway.
5. In TagoIO open "Live Inspector" of the device and start it. The messages of the meter rows appear.

The use of the data (dashboards, graphs) is done in the MQTT platform.

This chapter applies to the LoRaWAN models for Europe 868 MHz: LKM354, LKM454, LKM755, LKM354-Lite and LKM616. They read the meters as the other models do, serve the values over Modbus (and MQTT) and send them to a LoRaWAN network server. The pages "LoRa Settings" and "LoRa Status" are shown only on these models.

The example uses The Things Network (TTN) as network server and the example data set of 12.6 "Example: three meters, read with a Modbus TCP master" (three IEC meter rows, factory IEC list with 24 enabled codes).

14.1 LoRa Settings

First enter the meters and check the readings (12.6 "Example: three meters, read with a Modbus TCP master", steps 1 to 4). Then open "LoRa Settings".

Copy the EUIs and keys from the network server in full: an entry with fewer digits is refused (10.7.2 "Device Activation Over the Air (OTAA)").

NOTE:

"Send OBIS Code Details as Status Message At Start" is off at the factory. At SF12 the OBIS list needs many messages before the first meter data. Turn it on only if your application needs the code list from the gateway.

Click "Save Configuration" and restart the gateway ("Management" > "Reboot Device"). Of the OTAA and ABP values only those of the selected "Activation Method" are saved (10.7.4 "Communication Settings"). The LoRa settings are written to the radio module at the start.

NOTE:

On the LoRaWAN models "Set Device Time" on the "Management" page also sets the time of the radio module. The gateway does not restart. The page answers "Device time has been set.".

14.2 Add the end device in TTN - entered manually

In the TTN console click "+ Register end device", choose "Enter end device specifics manually" and select the frequency plan "Europe 863-870 MHz" and the LoRaWAN version and regional parameters version of the device. Enter the JoinEUI (the same value as "Application EUI" on the gateway), the DevEUI (copy it with "Copy" next to "Device EUI") and generate or enter the AppKey (the same value as "Application Key"). Click "Register end device".

14.3 Add the end device in TTN - from the device repository

Choose "Select the end device in the LoRaWAN Device Repository", search for the brand REDZ, select model, hardware version, firmware version, profile and frequency plan. Then enter JoinEUI, DevEUI and AppKey as in 14.2 "Add the end device in TTN - entered manually".

14.4 Check the activation

Open "LoRa Status". "Network Status" shows "JOINING (OTAA)" while joining and "ACTIVE (OTAA)" (or "ACTIVE (ABP)") when the device has joined. Then "Data Rate", "LoRaWAN Port Number", "Maximum Payload Size", "Device Address" and "Power Level (EIRP)" are shown. "Latest LoRaWAN Message Sent" shows the last payload in hex and as ASCII.

The "Device Status" page counts the LoRa messages ("N. of LoRa Messages Sent Correctly", "N. of LoRaWAN Messages Lost", "N. of LoRaWAN Messages Pending", "Last LoRaWAN Message Duty Cycle Block Time (s)"). The "LoRaWAN" card at the top of the page shows the network status and the time of the last uplink (10.5 "MENU: Device Status").

If the activation takes long, turn on the device log and follow it on the console or UDP log (chapter 18 "Logs and Troubleshooting"). In TTN, "Live data" shows the uplinks.

14.5 Messages sent to the network server

After every join the gateway sends, in this order:

1. a LoRaWAN time request (DeviceTimeReq) to set its clock,
2. the status message (port 1),
3. the OBIS details message (port 2) - only if "Send OBIS Code Details as Status Message At Start" is on,
4. then the meter data messages ("LoRaWAN Port", factory 3).

A step that cannot be completed in 5 tries or 180 seconds is skipped, so meter data is never blocked by steps 1 to 3. The status or OBIS details message of a skipped step is dropped and counted in "N. of LoRaWAN Messages Lost", unless the radio module is still sending it.

All messages start with the same two fields:

14.5.1 Status message (port 1)

Time format (32 bits, big-endian): bits 0-5 seconds, 6-11 minutes, 12-15 month, 16-20 hours, 21-25 day, 26-31 year - 2000.

Example (built from the format, not captured): 3 meter rows, factory OBIS lists, port 3, gateway time 2026-10-16 10:30:00, v3.00.02, factory name LKM_LW_SERVER:

00 03 BF EB  00  03  18 30 30 30 30 30  03  6A 0A A7 80  03 00 02  4C 4B 4D 5F 4C 57 5F 53 45 52 56 45 52

14.5.2 OBIS details message (port 2, optional)

One message for each profile that an enabled meter row uses. After byte 4 (0x01) it carries one 8-byte entry per enabled OBIS code, in index order:

For the IEC 62056-21 profile the groups of the code are placed from byte 2 on and the rest is 0: "1.8.0" -> 01 08 00 00 00 00, "F.F" -> 0F 0F 00 00 00 00, "C.1.0" -> 0C 01 00 00 00 00.

NOTE:

For the DLMS profiles the index of a code is its position in the stored list. Unchecking a code moves the codes after it, and newly checked codes are added at the end (11.7 "Default OBIS lists"). Read the code list (or this message) again after every change of a DLMS list.

14.5.3 Meter data message ("LoRaWAN Port", factory 3)

The values are those of the enabled OBIS codes of the row's profile, in index order; disabled codes are skipped. The value of a code is the same 32-bit integer as in the Modbus register, with the same word order ("Modbus Word (Register) Swap") and the same limits (signed and unsigned values, limit values, 11.5 "Data types and value conversion"). To know which code a value belongs to, use the enabled list of the profile (from the gateway configuration or from the OBIS details message).

A meter data message of a row is sent when "Minimum Send Interval for a Parsed Data (in seconds)" has passed since the last message of that row. Between two uplinks there are at least 10 seconds. The message is built when it is sent, from the values the row has at that moment (the same values as in the Modbus registers); while a message of a row is waiting, new readings of that row change these values and do not add a second message. A row that is being read at that moment is sent after the reading has ended. The remaining packages of a split message carry the values of its first package. A failed reading or an "ID MISMATCH" reading adds no message; a message that is already waiting is sent with the values the row has then.

With "Data Transmission with ACK" a message that gets no ACK from the network server is sent again a limited number of times. When it still has no ACK, it is dropped and counted in "N. of LoRaWAN Messages Lost".

14.6 Messages longer than the maximum payload

The gateway reads the "Maximum Payload Size" from the radio module (51 bytes at SF12 in EU868) and splits longer messages itself. Each package repeats the device ID and the type byte with the package number in the upper 4 bits; a meter data package also repeats the row number and gives the OBIS index of its first value. When the radio module reports that the duty cycle blocks the channel, the gateway waits the time given by the module ("Last LoRaWAN Message Duty Cycle Block Time (s)" on "Device Status") and sends the next package then.

Example (built from the format, not captured): row 1 of 12.6 "Example: three meters, read with a Modbus TCP master", IEC 62056-21 meter, factory list (24 enabled codes), payload 51 bytes. The 96 data bytes are sent in 3 packages of up to 10 values:

00 03 BF EB 02 01 01 28 00 00 00 00 00 01 92 23 00 03 FB 98 00 04 9D 1F 00 02 BF 98 00 01 7C E8 00 00 60 9F 00 00 30 70 00 00 1F A4 00 00 10 CC
00 03 BF EB 12 01 0B 28 00 00 00 00 00 00 E2 90 00 00 04 E2 00 00 03 48 00 00 53 34 00 00 04 E2 00 00 01 AE 00 00 08 FD 00 00 08 FA 00 00 09 06
00 03 BF EB 22 01 15 10 00 00 02 08 00 00 01 E5 00 00 01 F6 04 EE 6A F3

The OBIS details message of the same profile needs 5 packages at 51 bytes (5 entries per package):

00 03 BF EB 01 00 01 0F 0F 00 00 00 00 00 02 00 09 01 00 00 00 00 03 00 09 02 00 00 00 00 04 01 08 00 00 00 00 00 05 01 08 01 00 00 00
00 03 BF EB 11 00 06 01 08 02 00 00 00 00 07 01 08 03 00 00 00 00 08 02 08 00 00 00 00 00 09 02 08 01 00 00 00 00 0A 02 08 02 00 00 00
00 03 BF EB 21 00 0B 02 08 03 00 00 00 00 0C 05 08 00 00 00 00 00 0D 06 08 00 00 00 00 00 0E 07 08 00 00 00 00 00 0F 08 08 00 00 00 00
00 03 BF EB 31 00 10 01 06 00 00 00 00 00 11 02 06 00 00 00 00 00 12 20 07 00 00 00 00 00 13 34 07 00 00 00 00 00 14 48 07 00 00 00 00
00 03 BF EB 41 00 15 1F 07 00 00 00 00 00 16 33 07 00 00 00 00 00 17 47 07 00 00 00 00 00 18 0C 01 00 00 00 00

If the payload is too small for even one value, the package is dropped and counted in "N. of LoRaWAN Messages Lost".

When a package of a split message is lost, the rest of that message is dropped; it is not sent later with another message. The message is counted once in "N. of LoRaWAN Messages Lost".

14.7 Payload formatter (firmware 3.00.02)

The formatter below decodes the three message types for TTN (it also works as a ChirpStack v4 codec). Set WORD_SWAP to true when "Modbus Word (Register) Swap" is on. Values are returned as raw integers; apply the scale of each OBIS code in your application. value32 returns a signed 32-bit value. For a code that cannot be negative (for example energy) whose raw value can be above 2147483647, use the unsigned value (value32(b, i) >>> 0) in your application. The limit values of 11.5 "Data types and value conversion" come out as -1 (4294967295) and -2147483648.

var WORD_SWAP = false;
var PROFILES = ["IEC 62056-21", "Landis+Gyr DLMS", "Actaris/Itron", "Iskra DLMS", "Cewe DLMS", "Generic DLMS"];

function u32(b, i) { return ((b[i] << 24) | (b[i + 1] << 16) | (b[i + 2] << 8) | b[i + 3]) >>> 0; }

function value32(b, i) {
  var v = WORD_SWAP ? (((b[i + 2] << 24) | (b[i + 3] << 16) | (b[i] << 8) | b[i + 1]) >>> 0) : u32(b, i);
  return v > 0x7FFFFFFF ? v - 0x100000000 : v;   // signed 32-bit (negative IEC and DLMS values)
}

function rtc(t) {
  return { year: 2000 + ((t >>> 26) & 0x3F), month: (t >>> 12) & 0x0F, day: (t >>> 21) & 0x1F,
           hour: (t >>> 16) & 0x1F, minute: (t >>> 6) & 0x3F, second: t & 0x3F };
}

function decodeUplink(input) {
  var b = input.bytes;
  if (b.length < 5) { return { errors: ["too short"] }; }
  var d = { deviceId: u32(b, 0), type: b[4] & 0x0F, package: (b[4] >> 4) & 0x0F };
  var i;
  if (d.type === 0 && input.fPort === 1) {
    d.meterRows = b[5];
    d.obisCount = {};
    for (i = 0; i < 6; i++) { d.obisCount[PROFILES[i]] = b[6 + i]; }
    d.dataPort = b[12];
    d.time = rtc(u32(b, 13));
    d.firmware = b[17] + "." + ("0" + b[18]).slice(-2) + "." + ("0" + b[19]).slice(-2);
    d.name = String.fromCharCode.apply(null, b.slice(20));
  } else if (d.type === 1 && input.fPort === 2) {
    d.obis = [];
    for (i = 5; i + 8 <= b.length; i += 8) {
      d.obis.push({ profile: PROFILES[b[i]] || b[i], index: b[i + 1] - 1, groups: b.slice(i + 2, i + 8) });
    }
  } else if (d.type === 2) {
    d.row = b[5];
    d.firstIndex = b[6] - 1;     // index of the first value; the next values belong to the next ENABLED codes
    d.values = [];
    for (i = 8; i + 4 <= 8 + b[7] && i + 4 <= b.length; i += 4) { d.values.push(value32(b, i)); }
  } else {
    return { errors: ["unknown message type " + d.type + " on port " + input.fPort] };
  }
  return { data: d };
}

NOTE:

The formatters of the earlier manual (firmware before v2.7.0, and v2.7.0 and later) are replaced by this formatter. Use this one for firmware 3.00.01 and 3.00.02 (the message layout is the same).

Recordings of the web interface of a gateway with firmware 3.00.02. The videos have no sound; each step is described in the chapter named above the video.

15.1 Firmware update

The Management page of a gateway: the image file is chosen with "Select Firmware File", sent with "Upload Firmware" and checked by the gateway ("Checking...", then "Firmware Uploaded"); afterwards "Alternative Firmware Version" shows the uploaded version. The switch to the new firmware with "Reboot Alternative Firmware" is not part of the recording. Steps, limits and the upgrade from 2.x: 10.12.2 "Live Firmware Update", 16.4 "Update the firmware from the web interface" and 16.6 "Upgrade from firmware 2.x".

15.2 Reading meters over Modbus TCP

The example of 12.6 "Example: three meters, read with a Modbus TCP master" on a gateway in the function "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)": the meter rows on the "Operating Mode" page, the OBIS codes on "Gateway Settings", and the pages "Device Status", "Meter Reading Status" and "Gateway Status" while a Modbus TCP master reads the meters. The connection of the gateway to the meters (direct cable or optical probe) is shown in the diagrams of 9.1 "Scenario 1 - Meter on a direct cable, read over Modbus TCP" and 9.2 "Scenario 2 - Meter on an optical probe, read over Modbus TCP".

This chapter describes firmware 3.00.02: what changed since 3.00.00, which update keeps the settings, how to update the firmware from the web interface and how to back up and restore the configuration. The firmware version and its build date are shown in the header of every web page ("Version: 3.00.02, -built: <date>").

16.1 What is new in 3.00.02 and 3.00.01

16.1.1 Changes in 3.00.02

16.1.2 Changes in 3.00.01

NOTE:

In DHCP client mode, the DHCP re-discover step can change the IP address or drop it for a moment, so a Modbus TCP or web connection can be interrupted once. When the network gateway itself cannot be reached (not only the MQTT broker), the network check of a unit in DHCP client mode can still restart the unit.

16.2 Which update keeps the settings

The settings are carried to the new firmware only when the first two numbers of the version are the same (for example 3.00.xx to 3.00.yy).

Both "Kept" rows were checked on units: after the update the configuration was the same as before, except the "_meta" block of the configuration file (it names the firmware version).

A meter row value that the unit cannot use is set to its factory value at the start (16.1.1 "Changes in 3.00.02").

NOTE:

Before every update, download a configuration backup (see 16.7 "Configuration backup and restore"). After an update from 2.x you upload this backup to the new firmware.

16.3 Choose the correct firmware image

The firmware package has one image (.binimg) for each model group:

Use the image whose file name matches your model. The unit itself only refuses an image of the other key group:

WARNING:

An image of another model of the same key group is accepted by the unit (for example a LoRaWAN or BPL image on an LKM154, or an LKM616 image on an LKM154-Lite) and does not work correctly on your unit. Check the model on the label and the product name in the web header (1.3 "Product names shown by the device") before you upload.

We recommend abcZ Network Tool for firmware updates, because it checks that the image matches the model (chapter 17 "Software - abcZ Network Tool").

16.4 Update the firmware from the web interface

The new firmware is written into the second (alternative) firmware bank. The running firmware is not changed until you start the new one.

1. Open the "Management" page.
2. In "Live Firmware Update", click "Select Firmware File" and choose the .binimg file of your model. The file name is shown under "Firmware file to upload".
3. Click "Upload Firmware". The window "Upload firmware file" shows the progress ("%1" ... "%100"), then "Checking...".
4. Wait for "Firmware Uploaded" (shown with a check mark). "Alternative Firmware Version" and "Alternative Firmware Date" now show the new firmware.
5. Click "Reboot Alternative Firmware". The device asks "Reboot into the ALTERNATIVE firmware? The device will switch firmware banks." Click "Confirm".
6. The device shows "Reboot Alternative Firmware Command has been sent." and "Rebooting...". After about 5 seconds the page loads again, whether the unit is already up or not. If the page does not open, wait and refresh it. After an update from 2.x the unit has factory settings and can have a new IP address (see 16.6 "Upgrade from firmware 2.x").
7. Check the version in the web header.

NOTE:

Do not close the page and do not switch the unit off during the upload. If the upload is cut, the running firmware is not affected; start the upload again.

16.4.1 Messages

NOTE:

Every upload first erases the alternative bank. After a failed upload the previous firmware is no longer in the alternative bank, even if the page still shows its version and date. Reload the page after a failed upload: "Reboot Alternative Firmware" is then disabled until an upload succeeds.

16.5 Go back to the previous firmware

After a successful update the previous firmware stays in the alternative bank. "Alternative Firmware Version" shows it. To go back, click "Reboot Alternative Firmware" and "Confirm". The previous firmware stays available until the next firmware upload.

NOTE:

Going back from 3.00.02 to 3.00.01 (or 3.00.00) keeps the settings, because the first two numbers of the version are the same. Going back from 3.x to 2.x does not carry the 3.x settings; check every setting after going back.

16.6 Upgrade from firmware 2.x

WARNING:

An update from 2.x to 3.00.02 resets every setting to the factory settings. Download a configuration backup on the 2.x firmware before the update (step 1) and upload it after the update (step 4).

1. On the 2.x firmware, click "Download Current Configuration" (or the download button of your 2.x web page) and keep the file.
2. Choose the image of your model (16.3 "Choose the correct firmware image"). Upload the 3.00.02 image and start it as described in 16.4 "Update the firmware from the web interface".
3. The unit starts with factory settings. It takes its IP address from a DHCP server: connect it to a network with a DHCP server and find the address it got (for example in the client list of the DHCP server, or with the abcZ Network Tool, 17.1 "Find the unit"). The web login is user "admin", password "admin". The header shows the red banner "FACTORY DEFAULTS - device is not configured" (on screen the dash is a long dash).
4. Open the "Management" page and upload the 2.x backup with "Upload Configuration File". The reply is "Configuration Uploaded (legacy config - no _meta) - device will restart".
5. After the restart, check every page. Settings that 2.x did not have keep their factory value.

NOTE:

On LoRaWAN models the red banner reads "FACTORY DEFAULTS - device is not configured (factory LoRaWAN identity: address collision risk)". It disappears as soon as the configuration differs from the factory settings. If the LoRaWAN identity is still the factory one, an orange banner stays: "FACTORY LoRaWAN IDENTITY - DevEUI/AppKey/DevAddr still factory: two recovered devices collide", until the LoRaWAN identity and keys are changed.

16.6.1 What behaves differently from 2.x

The table lists what you notice after the upgrade from 2.x, and what to do.

The changes of 3.00.01 and 3.00.02 against 3.00.00 are listed in 16.1 "What is new in 3.00.02 and 3.00.01".

16.7 Configuration backup and restore

16.7.1 Download the configuration

On the "Management" page, in "Download / Upload Configuration", click "Download Current Configuration". The browser saves the file "ZTG_<Device Name>_v3.00.02.zcfg". It is a text file (JSON) with all settings of the unit. Its first block "_meta" names the product, the model variant, the firmware version and build and the device name.

WARNING:

The downloaded configuration file contains the web password, the MQTT password, the DLMS meter passwords and the LoRaWAN keys in clear text. Keep the file private: store it in a safe place and do not send it to others.

NOTE:

Start one configuration download at a time. If a second download is started while the first one is still running, the first file ends early. A complete file ends with "}"; a file that is not complete must be downloaded again.

16.7.2 Upload a configuration

1. On the "Management" page, click "Upload Configuration File" and choose the file.
2. The window "Upload Configuration file" shows the reply of the device.
3. When the reply starts with "Configuration Uploaded", the settings are saved and the device restarts itself. Wait for the restart, then log in again.

NOTE:

The file also sets the web password. After the restart, log in with the password that was valid on the unit the file came from.

The device checks the "_meta" block of the file before it saves anything:

NOTE:

The unit checks the values of the meter rows in the file. A value that the unit cannot use (for example a "TCP Port:" of 0 or a "Reading Table Code:" above 9) is replaced by the factory value of that field; the other values are stored as they are in the file. The reply is the same. Check the meter rows after the restart.

NOTE:

On LoRaWAN models the file carries the LoRaWAN identity and keys. Do not load the same file into two units without changing the LoRaWAN settings of one of them; two units with the same identity disturb each other on the LoRaWAN network.

The abcZ Network Tool is our Windows program for REDZ devices on an Ethernet network. With LKM Series gateways it finds the units and shows their address, product, firmware version and MAC address, reads the identity of one unit, gives a unit a static address, and updates the firmware of one unit or of many units at once. This chapter describes version 1.1.0 and only what you need with an LKM unit. Download the tool and its own user guide from the Support page of redz-sc.com (https://redz-sc.com/en/support).

The tool talks to the unit the way a web browser does. Type the user name ("admin") and the password of the unit's web interface (10.1.2 "Logging in") in "User" and "Password" on each tab. A unit with another password is listed with "auth required (password?)" in the "Product" column.

The tool reads the same pages and sends the same requests as the web interface: the firmware file is uploaded in the same way as with "Upload Firmware" and the switch to the new firmware is the same command as "Reboot Alternative Firmware" (16.4 "Update the firmware from the web interface").

17.1 Find the unit

Open the "Discovery" tab. In "IP range" type the addresses to search: a network such as 192.168.10.0/24, a range of the last number such as 192.168.10.1-254, a range such as 192.168.10.10-192.168.11.50, or one address. Click "Scan (HTTP)": the tool reads the start page of every address in the range, so it also finds units behind a router. Each unit found appears as a row with "IP", "MAC", "Series" (LKM), "Product" (the product name of 1.3 "Product names shown by the device"), "Device" (the "Device Name" of the unit), "Version" and "Build date".

"Discover (UDP)" is faster: it asks with a broadcast on UDP port 30303, which the unit answers with its MAC address and its network host name. A broadcast does not cross routers, so it finds only units in the same subnet as the PC. The units that answer are then read in the same way as with "Scan (HTTP)".

A unit that is not found may have no address from a DHCP server. It then works with the address stored in its configuration (192.168.1.1 on a unit with factory settings) and without a gateway, so it answers only a PC in its own subnet (10.1.1 "Finding the IP address"). Search from a PC in that subnet, for example with the address 192.168.1.10 and the net mask 255.255.255.0.

Double-click a row to open the unit's web interface in your browser. "Series filter" and "Find" narrow the list. "Export CSV" saves the selected rows (or all rows shown) as a list for "Fleet Update" (17.5 "Update many units").

17.2 Read the identity of one unit

On the "Single Device Update" tab, type the unit's address in "Device IP" and click "Read Identity (safe)". The panel "Device identity (last read)" shows the product name, firmware version, build date, MAC address and device name. Nothing is changed on the unit. If "Expected product" is empty, the tool fills it with the product name it read; this name protects the firmware update (17.4 "Update the firmware").

The LKM616 and the LKM354-Lite show the same product name (1.3 "Product names shown by the device"). Before an update the tool also reads the model variant that the unit writes at the start of its configuration file, and tells the two models apart by it.

17.3 Give the unit a static address

On the "Discovery" tab, right-click the unit's row and choose "Set IP / Subnet / Gateway (one device)...". The tool first reads the network settings of the unit; the window "Set network - <address>" then shows "IP address", "Subnet mask" and "Gateway" as they are stored for the static address ("Server IP Address", "Server Net Mask" and "Server Gateway Address" on the "Network Settings" page, 10.3.3 "Device Network Settings"). A unit that has its address from a DHCP server shows these stored values, not the address it uses now.

Type the new values, click "Apply" and type SET to confirm. The tool turns on "Use Static Address for Device", saves the three values (the other network settings are kept), restarts the unit and looks for it by its MAC address in the new subnet. When it finds the unit there, the log says "now reachable at" with the new address. When it does not, the log warns that the unit was not found by its MAC address, and the "Status" column shows "IP set? not found at" with the address you typed. While a scan or an update is running, the tool refuses this command; wait until the task ends.

NOTE:

If the unit is not found after the change, check the new address with "Scan (HTTP)" or in your browser. A wrong subnet mask or gateway can make the unit unreachable.

17.4 Update the firmware

On the "Single Device Update" tab:

1. Type the unit's address in "Device IP" and click "Read Identity (safe)", so that "Expected product" holds the product name of this unit.
2. Click "Browse..." and choose the firmware image (.binimg) of your model from the firmware package (16.3 "Choose the correct firmware image"). Keep the file RELEASE_v3.00.02.json of the package next to the image: the tool then checks the image against it.
3. Click "Update" and confirm.

Before it writes, the tool stops when the product name read from the unit is not the expected one (this cannot be overridden), skips a unit that already runs the version in the file name (tick "Force (flash even if version matches)" to write it anyway) and asks before it writes an image of another model, for example a LoRaWAN or BPL image for an LKM154, or an LKM616 image for an LKM154-Lite: answer No in the window "Image / device mismatch" and the unit is not touched. The unit itself refuses only an image of the other key group (16.3 "Choose the correct firmware image"); the tool also warns about an image of another model of the same key group.

The image is written into the unit's alternative firmware bank; the tool then sends the command to start it once, waits for the restart and compares the version and build date the unit reports. The log ends with "RESULT:" and "SUCCESS" when the unit reports the version and build date of the uploaded image. The tool sends every request on a new connection, as the unit requires (16.1.1 "Changes in 3.00.02").

The settings of the unit are kept when the first two numbers of the version stay the same, for example from 3.00.01 to 3.00.02; an update from 2.x starts the unit with factory settings and possibly another address (16.2 "Which update keeps the settings" and 16.6 "Upgrade from firmware 2.x"). Find the unit again with "Scan (HTTP)" by its MAC address.

NOTE:

"Factory reset after update" deletes every setting of the unit after the update, including the password and the network settings, and its address may change. Leave it off unless you want the factory settings.

17.5 Update many units

The "Fleet Update" tab updates a list of units from a CSV file with the columns ip, expected_product and image_path (the image path is relative to the CSV file). "Export CSV" on the "Discovery" tab writes such a list with the image column empty. "Validate CSV (dry-run)" checks the list without writing. With a "Pilot IP (opt.)" the tool updates that unit first and leaves all the others untouched if it fails; the rest are then updated "Parallelism (jobs)" at a time. A list can hold different LKM models: give each row the image of its own model.

The unit can send log lines about its operation to its console port or to a UDP log server. This chapter explains how to turn the log on and how to read it, lists the lines you are most likely to see, and collects the known behaviours of firmware v3.00.02 that are easily taken for a fault.

18.1 Turning on the log

The log is set on the "Management" page, card "LOG" (10.12.5 "LOG"):

1. Choose the "Log Level": "ERROR", "INFO" or "DEBUG" ("NONE" switches the log off; factory setting).
2. Choose the "Log Output": "UDP SERVER" sends the lines to a PC, "CONSOLE" to the console port of the unit (for REDZ service). Lite and EMH models offer only "UDP SERVER".
3. For "UDP SERVER" enter the address of the PC in "UDP Server IP" and its port in "UDP Server Port" (factory 192.168.1.10 and 7001).
4. Press "Change Log Level and Reboot". When a log setting changed, the unit restarts and sends its log from the start-up on.

On the PC, any program that receives UDP datagrams on that port can show the log. The unit does not store its log: lines are sent when they are made, and lines sent while no program receives them are lost. Start the receiver before the event you want to see.

On the "Device Status" page, "Log Status" and "Log Counter" (10.5.2 "Communication Counters") show the state of the log output and the number of lines sent, as long as the log is on.

18.2 Reading a log line

Every line starts with the date and time of the unit, then the type of the line and the text:

21-10-26 10:53:54 DBG-Identification message received...
21-10-26 10:53:54 DBG-/ELM5METER2
21-10-26 10:53:54 DBG-uptime min: 2
21-10-26 10:53:55 DBG-Make Data 7E1
21-10-26 10:53:55 DBG-Switch SerialSetup FOR SERIAL OK: 9600

With "INFO" a unit in the function "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)" that reads its meters without errors adds no line after the start-up lines. Use "DEBUG" to follow the readings step by step, and switch it back to "INFO" or "ERROR" afterwards.

Until the unit has the time from the NTP server (10.3.1 "NTP Settings") or from "Set Device Time" (10.12.1 "Set Device Time"), the lines carry a date such as 30-11-99 or 01-01-25. On models without LoRaWAN, "DEBUG" shows a line "Set Device time:" with the new time when the NTP server has set the clock.

A line holds at most 82 characters. A longer line is cut and ends with "~"; the end of its text is not sent. The tables below therefore give some lines only by their beginning.

When the unit makes lines faster than it can send them (for example with "DEBUG" and much traffic), it keeps the older lines, drops the newer ones and reports their number later in one line (18.3.7 "Daily restart and log output"). Only log lines are lost; meter reading, Modbus, MQTT and LoRaWAN are not affected.

18.3 Log lines you may see

The tables list the lines you are most likely to see, when they appear and what to do. The messages of the meter readings (for example "READING FINISHED", "ID MISMATCH" or "DLMS LOGIN REJECTED") are explained in 10.10.2 "Messages of the unit"; they are shown on the "Meter Reading Status" page.

18.3.1 Start-up

18.3.2 Network

18.3.3 MQTT

18.3.4 Modbus

18.3.5 LoRaWAN models

18.3.6 Firmware update and configuration

18.3.7 Daily restart and log output

18.4 Known behaviours and limits

The following behaviours of firmware 3.00.02 are known and intended or accepted. They are listed here so that they are not taken for a fault.

18.5 Information for REDZ support

When you contact REDZ support, send:

• the model (label of the unit), and the product name, the firmware version and build date and the MAC address from the header of the web page,
• the "Device Function" of the "Operating Mode" page and the "App Status" of the "Device Status" page,
• the time of the event and what you saw,
• the lines of the "Meter Reading Status" page when a meter reading is concerned,
• the log around the event (with "DEBUG" if possible), including the first lines after a start-up (BOOT rcon=... and the line after it).

NOTE:

The configuration file contains passwords and keys (16.7.1 "Download the configuration"). Send it only when REDZ support asks for it.

20.1 LKM Series

NOTE:

* The LKM655 is made in three versions: LKM655-PN-AC and LKM655-PP-AC with three-phase AC power input (phase to neutral or phase to phase BPL data connection), and LKM655-PP-DC with 9 - 36 V DC power input (phase to phase). See chapter 19 "Ordering Information".

20.2 LKM LoRaWAN Series

NOTE:

* The LKM755 is made in three versions: LKM755-PN-AC and LKM755-PP-AC with three-phase AC power input (phase to neutral or phase to phase BPL data connection), and LKM755-PP-DC with 9 - 36 V DC power input (phase to phase). See chapter 19 "Ordering Information".

All models convert the meter data to Modbus and can send it to an MQTT broker. All models except LKM615 and LKM616 can work as "Serial Electricity Meter to Modbus TCP Gateway (and MQTT Publisher)" or as "TCP/IP Electricity Meter to Modbus RTU Gateway (and MQTT Publisher)"; LKM615 and LKM616 work as the first one only. Ports and power of each model: chapter 19 "Ordering Information".