SOFTLINK WACO WM868 Instruction Manual

Wireless communication system
Hide thumbs Also See for WACO WM868:
Table of Contents

Advertisement

Quick Links

WIRELESS COMMUNICATION SYSTEM
WACO WM868
WM868-MM-B
Revision 1.0
SOFTLINK s.r.o., Tomkova 409, 278 01 Kralupy nad Vltavou, Czech Republic
Phone.: +420 315707111,
e-mail:
sales@softlink.cz,
www.softlink.cz

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WACO WM868 and is the answer not in the manual?

Questions and answers

Summary of Contents for SOFTLINK WACO WM868

  • Page 1 WIRELESS COMMUNICATION SYSTEM WACO WM868 WM868-MM-B Revision 1.0 SOFTLINK s.r.o., Tomkova 409, 278 01 Kralupy nad Vltavou, Czech Republic Phone.: +420 315707111, e-mail: sales@softlink.cz, www.softlink.cz...
  • Page 2: Table Of Contents

    Contents 1 Introduction 1.1 WACO communication system ........1.2 LoRaWAN communication system .
  • Page 3 List of Tables Overview of technical parameters of the WM868-MM-B module ..... Overview of communication protocols of the WM868-MM-B module .
  • Page 4: Introduction

    Introduction This document describes the configuration options of the WM868-MM-B radio module, which is used for reading the status of consumption meters with a M-Bus bus interface and for radio transmission of information about the current status of consumption meters via radio messages in WACO, LoRa, or Wireless M-Bus format. WACO communication system WACO (Wireless Automatic Collector) is radio frequency (RF) communication system intended especially for the remote reading of consumption meters (smart metering area), automatic data collection from sensors (telemetry...
  • Page 5: Wireless M-Bus Communication Protocol

    Wireless M-BUS Communication Protocol Wireless M-BUS is the communications protocol described by international standards EN 13757-4 (physical and link layer) and EN 13757-3 (application layer), which is intended primarily for radio transmission of remote reading values from consumption meters and sensors. Protocol Wireless M-BUS (hereinafter WMBUS”) is based on a ”...
  • Page 6: Principle Of Data Transmission From The Wm868-Mm-B Module To Another Waco Radio Module

    In WACO transmission mode, messages can be transmitted directly to another WACO system module that is constantly receiving. Figure shows the data transmission from the WM868-MM-B module to the so-called ”Col- lecting Unit” of the WACO system, which collects data from battery-powered WACO modules, converts data into standard M-Bus protocol messages, and forwards them to the bus control unit (device type ”M-Bus Master”) in M-Bus format via physical bus.
  • Page 7: Overview Of Technical Parameters

    Overview of technical parameters Table 1: Overview of technical parameters of the WM868-MM-B module Radio interface Frequency band Transmission modes WACO, wM-Bus, LoRa Modulation type - WACO GFSK Modulation type - wM-Bus Modulation type - LoRa spread spectrum Transmission power 10 - 25 Channel width - WACO 100 (15)*...
  • Page 8: Module Configuration

    ” Description of connecting the module to a mobile phone via Bluetooth wireless connection and general rules for configuring the module using the mobile application ”Softlink Configurator” are described in Chapter 3 of the above-mentioned manual Configuration of wacoSystem product family devices”. In section ”Setting the pa-...
  • Page 9 wm868-MM-B>conf Config : OK --- WACO protocol --- channel Group Hop count Repeater Test timeout: 20 sec. Encrypt port: Repeat count: 1 Master : 0x010000FE Repeat tout : 1 (50 ms) --- RF Driver --- TX power : 14 dBm RX timeout : 4 (200 ms) High Gain --- Application ---...
  • Page 10: Overview Of Configuration Commands For The Wm868-Mm-B Module ("Help")

    . . . --- Common interface params --- ondelay : 20 offdelay --- Profile [0] --- periode : 1440 min. baud : 2400 baud Max baud : 0 baud response : 5 ticks (50 ms) delay : 1 ticks (50 ms) parity : none stop...
  • Page 11 wm868-MM-B>? - help info - print system info conf - print configuration write - write configuration clear - clear configuration mode - set mode [waco|lora|wmbus] reset - RESET chip sensors - print sensors info - rf commands waco - WACO commands lora - LoRa commands wmbus...
  • Page 12: Commands For Basic Module Control

    3.1.3 Commands for basic module control This group of commands contains commands for controlling and monitoring the module as a whole. These are the following commands: wm868-MM-B>? - help info - print system info conf - print configuration write - write configuration clear - clear configuration mode...
  • Page 13 parameters stored in FLASH. If the parameter should be set only temporarily (for example when turn on a ”test”), it is not needed to save the operational configuration to FLASH memory (after finishing diagnostics the ”test” will be turned off anyway). However, if it is necessary for the currently changed operating parameters to remain set permanently, it is necessary to enter at the end of the configuration sequence a command to save the current configuration to FLASH..
  • Page 14: Commands For Configuring The Rf Subsystem Of The Module

    3.1.4 Commands for configuring the RF subsystem of the module This group of commands is used to set those parameters of the RF subsystem of the WM868-MM-B module that are common to all modes. These are the following commands: - help info - print driver info clear...
  • Page 15: Commands For Configuring Waco Transmission Mode

    wm868-MM-B>rf rxt 10 RX timeout : 10 (500 ms) wm868-MM-B> Using the command ”rf active”, you can switch the RF subsystem to a permanently active mode, where the receiver is constantly receiving, except for moments of transmission. For the battery-powered WM868-MM-B module, such a setting would lead to rapid battery discharge, so it is strongly advised against using this command during normal module operation.
  • Page 16 kb/s with a theoretical receiver sensitivity of about 104 dBm, which allows communication in built-up objects in the order of tens of meters. Channels labeled ”3”, ”4”, ”5” and ”6” have a width of 15 kHz and are used for data transmission at a speed of 2.4 kb/s with a theoretical receiver sensitivity of about 120 dBm.
  • Page 17: Commands For Configuring Wireless M-Bus Transmission Mode

    WACO protocol port number and any string of up to 16 characters after the ”waco encrypt” command. Based on this string, the module generates a cipher according to the proprietary Softlink algorithm. Spontaneously sent INFO messages of the WM868-MM-B module have port number ”37”. The same string can be used to generate a key for decrypting messages on the receiving side (in the central data collection application) using the same algorithm.
  • Page 18 M-Bus standard. The code value for the WM868-MM-B module is set at the factory to ”SFT” (unique code of the manufacturer SOFTLINK) and unless there is a serious reason, the module manufacturer does not recommend changing the manufacturer code setting.
  • Page 19: Commands For Configuring Lora Transmission Mode

    The command ”wmbus ekey” is used to set the encryption key for message encryption using the AES-128 algorithm. Enter the 16-byte encryption key using the ”wmbus ekey” command followed by a string of 16 bytes, which we enter in hexadecimal form as 32 consecutive characters (characters ”0” to ”f”, without spaces and without prefixed ”0x”).
  • Page 20 The commands ”lora info” and ”lora regs” are used to display the settings of the LoRa subsystem. These commands are only used for module diagnostics in the manufacturer’s laboratory. The ”lora band” command can be used to set the regional frequency plan according to the LoRa specification. For the Czech Republic region in the 868 MHz band, the frequency plan EU863-870 (abbreviated as ”EU868”) is reserved, which corresponds to option ”0”.
  • Page 21 wm868-MM-B>lora rxdly Recv Delay : 2 wm868-MM-B>lora rxdly 1 Recv Delay : 1 wm868-MM-B> In ABP mode (Activation by Personalization), the first receive window always opens with the set ”lora rxdly” delay. This value is also stored in the network’s BackEnd, so the network always sends reverse channel messages in this window.
  • Page 22 --- LoRa App --- Dev Addr : 0x00000000 NwkSKey : 1a2b3c4d5e6fa1b2c3d4e5f6778899af AppSKey : 00000000000000000000000000000000 Similarly, the key for encrypting application data is entered using the ”lora appskey” command. Warning! For modules with OTAA activation mode, these two keys are not entered, the module creates them during the initialization process based on information from the network.
  • Page 23: Commands Of The "Application" Group For Setting The Data Sending Application

    be entered into the module configuration. When the module first logs into the network, it receives back from the network the network address ”NetAddr” and the ”JoinNonce” information, which it uses to create the ”Network Session Key” and ”Application Session Key” keys. The network BackEnd simultaneously generates both of these keys using the same algorithm.
  • Page 24 wm868-MM-B>bus info - print BUS info debug - set debug level conf - print Profile configuration colvars - print collected variables - add NEW profile iread - Read BUS using profile [0-1] ondelay - Set ON delay in 50ms ticks offdelay - Set OFF delay in 50 ms ticks baud - Set init.
  • Page 25 wm868-MM-B>bus conf --- Common interface params --- ondelay offdelay --- Profile [0] --- periode : 1440 min. baud : 2400 baud Maxbaud : 0 baud response : 40 ticks (50 ms) delay : 1 ticks (50 ms) parity : even stop data proto...
  • Page 26 wm868-MM-B>bus colvars 837224 wm868-MM-B> The procedure for setting the read variables is described below. The ”bus new” command allows you to easily set up a reading profile using a preset template. Templates can con- tain not only settings for bus communication parameters, but also settings for reading specific variables. Currently, the module contains only templates for typical bus communication parameter settings for individual communication modes.
  • Page 27 wm868-MM-B>bus iread 1 wm868-MM-B>/ZPA4ZE110.v30 012 spd=4 F.F(000000) C.1.0(05837224) C.90(837224) 1.8.1(0000038.6 kWh) 2.8.1(0000000.0 kWh) C.9.3(19-10-17 08:23) C.7.0(0159) 0.3.3(00250.000*i/kWh) 0.2.1(ZE110 DE 30) C.8.1(00000321:00 h:min) C.82.1(00000000:00 h:min) C.50(00002616:45*h:min) 31.6.0(002.382*A) 21.6.0(00.371*kW) When reading data using the M-Bus and IEC 62056-21 protocols, the meter sends a listing of all variables, with those set by the ”vadd”...
  • Page 28 wm868-MM-B>bus parity 0 parity [0] : 1 - even wm868-MM-B>bus data 0 data [0] wm868-MM-B>bus data 0 8 data [0] wm868-MM-B>bus stop 0 stop [0] wm868-MM-B>bus stop 0 1 stop [0] wm868-MM-B> The ”bus periode [index] [value]” command is used to set the period for reading the state of the meter with the given index and sending a message with the read values (the module sends the message immediately after reading).
  • Page 29 wm868-MM-B>bus proto 1 proto [1] : 1 - MBUS wm868-MM-B>bus proto 1 2 proto [1] : 2 - OPTO wm868-MM-B> The commands ”primary”, ”secondary”, ”oaddr”, ”omode”, ”modadr” and ”modmode” are intended for setting identifiers and modes for individual communication protocols. Individual commands can only be used for a profile on which the corresponding protocol is set.
  • Page 30 wm868-MM-B>bus modadr 2 120 Address [2] : wm868-MM-B> Using the ”bus modmode [index] [value]” command the Modbus protocol mode can be set for the given meter. RTU (variable value ”0”) and ASCII (variable value ”1”) modes are supported, with the binary RTU mode preset, which is mandatory for end devices.
  • Page 31 ”NEP” system, where the OID value ”80” is interpreted as ”External variable INTEGER” and ”1” is its distin- guishing index. When operating the module in ”Wireless M-Bus” transmission mode, variables in ”INFO” messages are encoded using DIF/VIF parameters of the M-Bus protocol (see the meaning and setting of the ”rfvif” parameter below).
  • Page 32: Commands Of The "System" Group For Module Initialization And Diagnostics

    into separate blocks requiring a function for reading the given block (see the description of the Modbus protocol - ”Modbus Application Protocol Specification” at www.modbus.org). If the WM868-MM-B module is operated in Wireless M-Bus transmission mode, messages with read values are encoded according to this standard.
  • Page 33: Commands For Setting The Bluetooth Subsystem

    The description of connecting the module to a mobile phone via Bluetooth wireless connection and general rules for configuring the module using the ”Softlink Configurator” mobile application are described in Chapter 3 of the manual ”Configuration of devices in the wacoSystem product line”.
  • Page 34: Forms For Setting Communication Of The Wm868-Mm-B Module With The Central System

    ”READ (GET)” button, when the form will show the parameter values that the module currently has stored in memory; The ”Softlink Configurator” application currently offers a set of configuration forms for configuring the WM868- MM-B module, which allow checking and setting all module parameters that are necessary for its installation and normal operation.
  • Page 35: Forms For Setting The Reading System Of The Wm868-Mm-B Module

    - setting of Application Session Key - setting of Application Key (Root Key) - setting of Join EUI - setting of device class Do not use! - setting of activation mode (ABP/OTAA) - enabling adaptive power function Do not use! - enabling application data encryption - setting of frequency band - setting of frequency channel...
  • Page 36 The ”Settings MODBUS” form is used to set communication parameters in Modbus format. The application offers four forms, but due to the maximum number of two connected meters, at most two of them can be used (if both connected meters will communicate using this protocol). The form contains these fields: - Address field for setting ID (bus address) - Mode field (RTU/ASCII) - Parity field for setting serial communication parameters (default 7E1)
  • Page 37: Setting Module Parameters From A Remote Computer Using The Reverse Channel

    of variable selection is different for different profiles: for M-Bus it’s DIF/VIF values, for Modbus register numbers and formats, for IEC2056-21 it’s OBIS codes. Enter the identification parameters with regard to which protocol it is read by. 4. If the module operates in Wireless M-Bus transmission mode set the VIF code according to the M-Bus standard for each read variable using the ”Out WMBUS Mapping”...
  • Page 38: Module Data Message Structure

    Individual variables are coded into the data content of the message by using of ”NEP” proprietary coding system invented by SOFTLINK. In this system each type of variable has its own designation called ”OID” (Object ID), which determines meaning, character and data type of the variable. These variables, that could be used multiple...
  • Page 39: Preview Of " Nep Coding Table" For Coding Of Variables In Waco System

    Figure 7: Structure of WACO system data packet times (as multiple inputs, temperatures, voltages...) must be used jointly with order number of the variable called ”Index”. NEP coding table” is centrally maintained by SOFTLINK and it is available on the public WEB address ” Page. Preview of NEP coding table”...
  • Page 40: Lora

    Message length (L) Message length in Bytes Packet type (C) ”Spontaneous User Data” Manufacturer ID (M) ”SFT” (Softlink manufacturer code) Serial number (A) Module identification according to M-BUS standard (configurable) Version (V) Module generation/version according to M-BUS standard (configurable) Medium (T) Type of measured medium according to M-BUS standard (configurable)
  • Page 41: Operating Conditions

    Operating conditions This section of the document provides basic recommendations for transportation, storage, installation, and operation of WM868-MM-B type radio modules. General operational risks Radio modules are electronic devices powered by their own internal battery, which register the status of counters or registers of connected consumption meters or sensors.
  • Page 42: The Condition Of Modules On Delivery

    if higher grade of protection against humidity required (IP68), perform additional sealing of the module by high-adhesion silicon filling according to producer instruction (*). This treatment can be also ordered at manufacturer; install modules only to the sites where relative humidity exceed value of 95% only occasionally; install modules only to the sites where they can be squirted or sprayed by water only occasionally and only for a short time;...
  • Page 43: Detailed View Of The Wm868-Mm-B Module

    Figure 10: Detailed view of the WM868-MM-B module The image shows important parts on the printed circuit board color-coded: configuration connector (green), battery switch (yellow), terminal blocks for connecting input signal cables (purple), and antenna connector (blue). Figure shows the WM868-MM-B module disassembled into individual components. Figure 11: Assembly of the WM868-MM-B module with rod antenna Figure shows the diagram for connecting cables from meters/sensors to the module’s terminal block.
  • Page 44: Connection Diagram Of The Wm868-Mm-B Module Terminals

    Figure 12: Connection diagram of the WM868-MM-B module terminals Figure shows the WM868-MM-B module with a connected rod antenna and a water meter sensor head with M-Bus output. In case of connecting two meters/sensors, it is possible to connect both cables in parallel to the same terminals, or to connect the cables from the meters in parallel on an auxiliary terminal block outside the module and connect this terminal block to the module with a single cable.
  • Page 45: Module And Meter Replacement

    connect the rod or stick antenna, or antenna cable from a remote external antenna, to the antenna connector. Thread the antenna or cable through the cable grommet directly opposite the antenna connector; switch both micro-switches (”jumpers”) located on the printed circuit board next to the configuration con- nector to the ”ON”...
  • Page 46: Module Disassembly

    Then set up the serial communication, reading profile, and read variables according to the procedure described in section 3.1.9 ”Commands for setting meter reading via bus interface”. (*) CAUTION! The new consumption meter may have a different network identifier and different communication parameters via the serial interface, even if it is a meter of the same type from the same manufacturer.
  • Page 47: Troubleshooting

    Troubleshooting Possible causes of system failures During operation of the WM868-MM-B device, failures, functional outages, or other operational problems may occur, which can be divided into the following categories based on their cause: 6.1.1 Power supplying failures The module is supplied by electrical power from the long-life internal battery. Approximate battery life is specified in paragraph Modul usage”.
  • Page 48: Procedure For Determining The Cause Of Failure

    certain elements of the network do not receive data from the module; data from certain elements of the network are incorrect or incomplete; there are numerous breakdowns in the data communication (sometimes the data pass through the module, sometimes not). All above described troubles could have on common ground, which is unreliability of radio-communication caused by one of these reasons: incorrect setting of transmitter parameters, mainly frequency channel, maximum number of re-translations,...
  • Page 49: Additional Information

    This manual is focused on description, parameters and configuration options of radio modules WM868-MM-B of the WACO RF system, operating in the 868 MHz band, that are a part of the Softlink’s wacoSystem product family. More information about all WM868 (WACO), WB169 (Wireless M-BUS), WS868 (Sigfox), or NB (NB-IoT) series of the modules can be found on the manufacturer website: www.wacosystem.com...

This manual is also suitable for:

Wm868-mm-b

Table of Contents