LANSEN WM-BUS B4 GW Manual

Wireless gateway documentation lte-m1 / gprs and ethernet gw
Table of Contents

Advertisement

Quick Links

Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10
Wireless M-BUS B4 Gateway documentation
LTE-M1 / GPRS and Ethernet GW
using optional
LansenConfigurator 1.6.2.0

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WM-BUS B4 GW and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for LANSEN WM-BUS B4 GW

  • Page 1 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Wireless M-BUS B4 Gateway documentation LTE-M1 / GPRS and Ethernet GW using optional LansenConfigurator 1.6.2.0...
  • Page 2: Table Of Contents

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Introduction ..................................4 MQTT traffic ..................................4 Packet sent by gateway with wM-Bus container ......................5 Sending configuration packets to a gateway ........................7 Alternative 1: M-BUS header for encrypted and non-encrypted configuration packets..........7 Alternative 2: M-BUS header only for non-encrypted configuration data.
  • Page 3 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Add meter(s) from file to internal routing list......................31 Delete meter(s) ............................... 31 Clock-tab ..................................32 Bridge-tab ..................................32 LTE gateway specific settings ..........................32 NTP ..................................33 Ethernet gateway specific settings .........................
  • Page 4: Introduction

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Introduction • This device from Lansen is a lightweight gateway that is made for receiving wM-Bus data and transmitting the data using LTE M1/GPRS or Ethernet, depending on variant, to an MQTT server. •...
  • Page 5: Packet Sent By Gateway With Wm-Bus Container

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Packet sent by gateway with wM-Bus container The data is packed into a wM-Bus container data record which is represented by the table below. Example packet complete MQTT packet:...
  • Page 6 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Value Example: 118 0x76 8 digit BCD 0x8C DIFE Subunit 1 0x40 Fabrication number 0x78 Repeater serial number (LSB) 0x09 Repeater serial number 0x00 Example: 00000009 Repeater serial number...
  • Page 7: Sending Configuration Packets To A Gateway

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Sending configuration packets to a gateway This chapter describes how to send configuration packets to a gateway. The packet is always sent to the topic LAS/W/C/12345678 where 12345678 is the serial number of the gateway.
  • Page 8: Alternative 2: M-Bus Header Only For Non-Encrypted Configuration Data

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Alternative 2: M-BUS header only for non-encrypted configuration data. This format is easier, compared to the previous alternative, but only supports non-encrypted configuration data. The Access number, byte 12, should be incremented by 1 for each packet sent to the gateway for best security.
  • Page 9: The Response From The Gateway

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 The response from the gateway The packet is always sent to the topic LAS/W/R/12345678 where 12345678 is the serial number of the gateway. Note: After the header, the configuration data is added – The configuration data is also referred to as ENAPI Data.
  • Page 10: Status Packet

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Status packet A status packet contains information and settings about the gateway and the packet is sent at regular intervals. In other words, a status packet is sent: •...
  • Page 11 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Type Device type 0x1B Acc. Access number 0x01 Status Errors and alerts Example: Low battery 0x04 Config. Configuration field 0x00 Example: Encryption off Config. Configuration field 0x00 ID-Field...
  • Page 12 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 16-bit integer + Extension 0x82 DIFE Storage 2 0x01 Value on Extension table 0xFD parameter VIFE Dimensionless 0x3A “Pause timer” Value (LSB) 0x8C Example: 1420 (0x058C) Value (MSB)
  • Page 13 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 DR13 Variable Length 0x8D DR13 DIFE Storage 6 0x03 DR13 Extension table 0xFD DR13 VIFE Dimensionless 0x3A DR13 LVAR ICCID string length (19-20 bytes) 0x14 DR13 ICCID Ascii string (LSB)
  • Page 14 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 DR19 32-bit integer + Extension 0x84 Number of DR19 DIFE Subunit 1 0x40 seconds for DR19 Operating time seconds 0x24 which the wM- DR19 Value (LSB) 0x07 Bus radio has...
  • Page 15: Ready-For-Conf Packet

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Ready-for-conf packet The Ready-for-conf packet is sent from the device every time upload of data from gateway is finished to MQTT. This indicates that the gateway is ready for configuration via MQTT.
  • Page 16: Indications Of A Gateway

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Indications of a gateway The device can use both visual indications (LED) and sound indications to show what is currently happening, e.g., how the startup sequence is going or if there are any errors after startup.
  • Page 17: Connection Sequence To Mqtt For Uploading Data (Battery Gateway)

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Connection sequence to MQTT for uploading data (Battery Gateway) This chapter describes the connection sequence for a battery-operated gateway. Note: The setting ‘Always connected to MQTT’ must not be set on a battery-operated gateway! The modem is started and immediately searches for an LTE M1 network.
  • Page 18: Notes Regarding Sim-Card And Pin

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Notes regarding SIM-card and PIN The device supports either an eSIM or a full-size SIM-card. If eSIM is required then the SIM must be mounted during production, thus must be ordered in advance.
  • Page 19: Battery Lifetime (Battery Gateway)

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Battery lifetime (Battery Gateway) Since the battery driven gateway has a large super capacitor to assist the battery, it is hard to measure the true battery voltage to determine the service life left on the device. One method to determine the lifetime to get an early warning is by using calculations based on how long the device has spent in the different modes as defined in chapter Power consumption.
  • Page 20 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Modem active power consumption Total time is already in seconds so we can calculate the total power consumption immediately since the power consumption when a radio is active is 160 mA, according to chapter Power consumption.
  • Page 21: Using Program Lansen Configurator For Configuration Of The Gateway

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Using program Lansen Configurator for configuration of the gateway The Lansen Configurator can be used to configure the gateway via the 868 MHz wM-Bus interface using a Lansen configuration dongle (LAN-WMBUS-D1/D2-TC) or directly via the MQTT server.
  • Page 22 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 In the sniffer tab, Packet Sniffer V2, you can see all the devices in the area as picked up by the dongle. • • • If encryption is enabled on the gateway, then a valid AES-key must be entered in the field marked below to change settings.
  • Page 23: Connect To The Gateway Over Mqtt Interface Using Lansen Configurator

    Connect to the gateway over MQTT interface using Lansen Configurator Start the Lansen Configurator and select the tab MQTT, as seen below, and enter the settings to the MQTT server to connect via the MQTT server. Example settings can be seen in the picture below.
  • Page 24 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 In the sniffer tab, Packet Sniffer V2, one will see all data that are transmitted by the gateway over the MQTT interface. To change settings to the gateway one must first connect to the gateway. This is done by clicking ‘Connect’ and then...
  • Page 25: Configuration Settings For A Gateway

    This chapter is the same regardless if the connection has been made using the wM-Bus interface (see chapter Connect to the gateway over wM-Bus interface using a Lansen USB-dongle or the MQTT interface (see chapter Connect to the gateway over MQTT interface ).
  • Page 26: Settings In The Gateway

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Settings in the gateway The following chapter will explain in detail what all the settings that are available mean. Note that all settings in the following chapter are supported by the Ethernet and LTE GW.
  • Page 27: Mbus Mode

    Note: If input mode is set to S, it will not be possible to configure the gateway further until the USB-dongle has been configured to send in S-mode. Contact Lansen for more information on how to proceed with this. Note: If input mode is set to S-mode, then the gateway will not receive with C- and T-mode.
  • Page 28: Timers-Tab

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Timers-tab This tab contains parameters for the gateway which are timer-based, such as listen and pause timer. It is also possible to configure if the gateway should wake up on specific days, e.g., Mondays.
  • Page 29: Magnet Reed Timer

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Magnet reed timer Note: This setting is not supported by the ethernet gateway. This parameter sets how many minutes the gateway is in forced listening mode when a magnet has been used against it.
  • Page 30: Meters-Tab

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Meters-tab The settings and options in this tab have to do with the internal routing list of a gateway. In this tab, meters can be viewed, added, and removed as explained in each chapter below.
  • Page 31: Add Meter(S) From File To Internal Routing List

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Add meter(s) from file to internal routing list Instead of adding a meter one by one, a user can instead import a csv-file with many meters. To add a whole file, click on “Browse” and select the csv-file with the meters to be added to the gateway. Once a file has been selected, click “Import csv-file”...
  • Page 32: Clock-Tab

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Clock-tab This tab shows information about the internal clock of the gateway. The upper field, Repeater clock (UTC), displays the internal clock of the gateway as UTC-time while the lower field, Clock diff (s), shows how many seconds the internal clock of the gateway differs from the current clock on the PC.
  • Page 33: Ntp

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 It is possible to turn on communication using TLS for the gateway when communicating with the MQTT broker. It is possible to enter a specific APN, if needed. This setting is always needed when the gateway is configured to use GPRS communication protocol.
  • Page 34: Ethernet Gateway Specific Settings

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Ethernet gateway specific settings These settings are only applicable for the ethernet gateway and not for the LTE gateway. DHCP enabled: Turn on or off depending on if DHCP should be used. If DHCP is enabled on the gateway, then IP address and network mask are retrieved from the DHCP server.
  • Page 35: Extra Screenshots From The Meters Tab With Details

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Extra screenshots from the Meters tab with details...
  • Page 36 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10...
  • Page 37 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10...
  • Page 38: Connecting And Working With Lansen Configurator (Battery Gateway)

    Connecting and working with Lansen Configurator (Battery Gateway) A battery-operated gateway is not always online (sleeping) to save battery. This must be considered when using Lansen Configurator, since trying to connect to a gateway may not happen right away like it would with a mains- powered gateway.
  • Page 39 The gateway was offline so the program waits for a connection from the gateway. Once the gateway is connected to the MQTT server and connection is established by Lansen Configurator, the countdown of the uptime will start. The counter shows the time left before the gateway shuts down the connection...
  • Page 40 Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 It is possible to extend the uptime by clicking ‘Extend’. The gateway closes the connection when the timer reaches 00:00 or when the button Disconnect is clicked.
  • Page 41: Upgrade Firmware

    Lansen manual for Lansen WM-BUS B4 GW (MQTT) Rev: K Date: 2024-04-10 Upgrade firmware To upgrade the firmware, a specific command must be sent to the gateway via MQTT or the LAN-WMBUS-D1/D2-TC configuration dongle. LTE gateway Below is an example setting.

Table of Contents