1. Manuals
  2. Brands
  3. SOFTLINK Manuals
  4. Wireless modules
  5. WACO WM868
  6. Instruction manual

SOFTLINK WACO WM868 Instruction Manual

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

Advertisement

Quick Links

Download this manual
WIRELESS COMMUNICATION SYSTEM
WACO WM868
WM868-IR-B
Revision 2.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

Related Manuals for SOFTLINK WACO WM868

Summary of Contents for SOFTLINK WACO WM868

  • Page 1 WIRELESS COMMUNICATION SYSTEM WACO WM868 WM868-IR-B Revision 2.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: Waco Communication System

    List of Tables Overview of technical parameters of the WM868-IR-B module ..... . Overview of communication protocols of the WM868-IR-B module .

  • Page 4: Introduction

    Introduction This document describes the configuration options of the WM868-IR-B radio module, which is used for reading the status of consumption meters with an IrDA infrared communication port 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: Module Usage

    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-Ir-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 illustrates the data transmission from the WM868-IR-B module to the so-called ”Collecting Unit” of the WACO system, which collects data from battery-powered WACO modules, converts the data into standard M-Bus protocol messages, and further transmits 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-IR-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: Configuration Of The Wm868-Ir-B Module

    Setting of WM868-IR-B parameters via configuration cable”. ” Description of interconnection of the module with a smartphone and general rules of configuration with using of ”Softlink Configurator” mobile application are described in the chapter 3 of above mentioned manual Con- ”...
  • Page 9 wm868-IR-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 Wm868-Ir-B Module Configuration Commands ("Help")

    . . . --- Common interface params --- ondelay offdelay --- Profile [0] --- periode : 1440 min. baud : 300 baud response : 40 ticks (50 ms) delay : 1 ticks (50 ms) parity : even stop data proto : OPTO Mode Address...
  • Page 11 wm868-IR-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-IR-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-IR-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-IR-B>rf rxt 10 RX timeout : 10 (500 ms) wm868-IR-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-IR-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-IR-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-IR-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-IR-B>lora rxdly Recv Delay : 2 wm868-IR-B>lora rxdly 1 Recv Delay : 1 wm868-IR-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: Commands For Setting Meter Reading Via Optical Interface

    3.1.9 Commands for setting meter reading via optical interface The WM868-IR-B module reads data from the internal registers of the connected meter (typically an electricity meter) via the meter’s IrDA optical interface (or another type of meter equipped with an optical interface), to which it connects via an IR-15 optical head.
  • Page 25 wm868-IR-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-IR-B>bus colvars 837224 wm868-IR-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-IR-B>bus iread 1 wm868-IR-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-IR-B>bus parity 0 parity [0] : 1 - even wm868-IR-B>bus data 0 data [0] wm868-IR-B>bus data 0 8 data [0] wm868-IR-B>bus stop 0 stop [0] wm868-IR-B>bus stop 0 1 stop [0] wm868-IR-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-IR-B>bus proto 1 proto [1] : 1 - MBUS wm868-IR-B>bus proto 1 2 proto [1] : 2 - OPTO wm868-IR-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-IR-B>bus modadr 2 120 Address [2] : wm868-IR-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-IR-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

    mode”. Other commands are used exclusively for setting basic parameters of the module during its initialization, or for its diagnostics in the manufacturer’s workshop. The manufacturer strongly recommends against using them during normal operation of the module. 3.1.11 Commands for setting the Bluetooth subsystem This group of commands can be displayed by entering the command ”ble”: wm868-IR-B>ble - TX power in dBm...

  • Page 34: Setting Module Parameters Using A Mobile Application

    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 35: Forms For Setting Wm868-Ir-B Module Communication With The Central System

    3.2.2 Forms for setting WM868-IR-B module communication with the central system The following set of forms is intended for checking the basic parameters of the module and for setting the module’s communication with the superior central data collection system: The ”Administration formular” is used to check the functionality of the module. It contains a listing of the main operating parameters and a button for starting the function.

  • Page 36: Forms For Setting The Wm868-Ir-B Module Reading System

    messages from individual meters). A preview of the screens of selected configuration forms for setting the module’s communication with the superior central data collection system is shown in Figure 4. Figure 4: Preview of forms for setting WM868-IR-B module communication using a mobile application 3.2.3 Forms for setting the WM868-IR-B module reading system The following set of forms is intended for setting communication with connected meters via the SI interface and for...
  • Page 37 The ”MBUS Variables” form is used to set all M-Bus type variables. Variables are selected by entering DIF/VIF parameters into the field with the given variable index (example: for the variable with index ”8” enter DIF/VIF into the ”MBUS Variable[8]” field). There are 16 fields available for assigning all 16 possible variables. The DIF/VIF data is only inserted into the fields of those variables that are read in M-Bus format.

  • Page 38: Setting Module Parameters From A Remote Computer Using The Reverse Channel

    Figure 5: Preview of forms for setting the WM868-IR-B module reading system using a mobile application Setting module parameters from a remote computer using the reverse channel The WM868-IR-B module supports communication in the so-called reverse channel (from the central application to the module) in WACO and LoRa transmission modes.

  • Page 39: 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 40: 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 41: 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 42: Operating Conditions

    Operating conditions This section of the document provides basic recommendations for transportation, storage, installation and operation of WM868-IR-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 43: 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 44: Detailed View Of The Wm868-Ir-B Module

    Figure 10: Detailed view of the WM868-IR-B module The figure shows important parts on the printed circuit board marked in color: configuration connector (green), battery switch (yellow), terminal block for connecting input signal cables (purple) and antenna connector (blue). Figure shows the WM868-IR-B module disassembled into individual components.

  • Page 45: View Of The Wm868-Ir-B Module With Connected Antenna And Optical Head

    Figure 13: View of the WM868-IR-B module with connected antenna and optical head The enclosure consists of two parts: base of the module, to which the printed circuit board is attached with cable grommets for the antenna and input signal cables; enclosure lid, covering the printed circuit board, with moldings for mounting the module to a surface.

  • Page 46: Replacement Of Modules And Meter Replacement

    When selecting the module installation location, antenna type and location, and antenna cable length, it is necessary to consider both protection of the module from possible mechanical damage (installation away from operationally exposed areas) and especially the conditions for radio signal propagation at the installation site. These conditions can either be determined (estimated) empirically, based on previous experience, or by measuring signal strength using a control transmitter/receiver.

  • Page 47: Operation Of The Wm868-Ir-B Module

    check the functionality of the RF subsystem using the RFAN 3.x analyzer. For this, it is necessary to switch the module to WACO transmission mode and receive messages from the module with the analyzer in ”Packets” or ”Radar” mode (according to the procedure described in the analyzer documentation), preferably using the test transmission function;...

  • Page 48: Troubleshooting

    Troubleshooting Possible causes of system failures During operation of the WM868-IR-B device, failures, functional outages, or other operational problems may occur, which can be divided into the following categories according to 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 49: Transmitter And Receiver Failures

    6.1.4 Transmitter and receiver failures If the module is powered by correct voltage, the module communicates through the configuration port, responds to the configuration commands but the radio-messages from the module are still not received steadily, the possible reason of the trouble can be a failure of transmitting or receiving of radio signal. The typical indication of trans- mitting or receiving failures is state of partial”...
  • Page 50 1. The module communicates normally, data can be read, but the data from some consumption meters are clearly incorrect. In this case, it is recommended checking the functionality of individual subsystems of the module in this order: check the correctness of the given input settings in the reading system, especially the correctness of the identification settings of the given meter and its correct assignment to the appropriate module profile;...

  • Page 51: Additional Information

    This manual is focused on description, parameters and configuration options of radio modules WM868-IR-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-ir-b

Table of Contents