SOFTLINK NB-R4-V Instruction Manual

Wireless communication system nb-iot
Table of Contents

Advertisement

Quick Links

WIRELESS COMMUNICATION SYSTEM
NB-IoT
NB-R4-V
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 NB-R4-V and is the answer not in the manual?

Questions and answers

Summary of Contents for SOFTLINK NB-R4-V

  • Page 1 WIRELESS COMMUNICATION SYSTEM NB-IoT NB-R4-V 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

    2 Overview of technical parameters 3 Configuration of the NB-R4-V module 3.1 Setting parameters of the NB-R4-V module using a configuration cable ....3.1.1 Listing of configuration parameters of the NB-R4-V module...
  • Page 3 ..... . . Connection of a meter with RS-485 output to the NB-R4-V module terminal block ..
  • Page 4: Introduction

    ”INFO message”). The NB-R4-V module can be used for reading up to 6 meters located on one RS-485 data bus, with the ability to read up to four selected variables (registers) from each connected meter with M-Bus, Modbus, or IEC 62056 encoding system.
  • Page 5: Module Properties

    Module properties The NB-R4-V module is enclosed in a moisture-resistant plastic box (IP65 protection) and is suitable for use in both indoor and outdoor environments. The box is designed for wall mounting or mounting on any structural element (beam, pipe...).
  • Page 6: Overview Of Technical Parameters

    Overview of technical parameters An overview of the technical parameters of the NB-R4-V module is provided in Table 1. Table 1: Overview of technical parameters of the NB-R4-V module NB-IoT transmitter parameters Frequency band 800 MHz (RX/TX) 791-821 / 832-862...
  • Page 7: Configuration Of The Nb-R4-V Module

    Setting parameters of the NB-R4-V module using a configuration cable The following part of the manual describes those parameters of the NB-R4-V module whose current values can be checked with using of directly connecting the module to a PC using a configuration cable, and possibly changed by entering of the configuration commands (configuration ”from the command line”).
  • Page 8 Reg value : 1.8.2 -- Register 4 -- Reg value : 2.8.0 RT : 4 * 50ms FT : 1 * 50ms Resp : 100 * 50ms iDel : 3 * 50ms Repeat : 2 Send periode : 0 min. NB-R4-V...
  • Page 9: Overview Of Configuration Commands Of The Nb-R4-V Module ("Help")

    3.1.2 Overview of configuration commands of the NB-R4-V module (”HELP”) The overview of configuration commands (”HELP”) and their parameters can be displayed by entering the command ”?” into the command line and pressing the ”ENTER” key. A ”Help” listing will appear in the terminal window, containing a summary of all configuration commands divided into several sections - see the example below.
  • Page 10 : Register address for value 2 type3 : Value type func3 : Readout command (1 - 4) reg3 : Register for value 1 type4 : Value type func4 : Readout command (1 - 4) reg4 : Register for value 1 : Send modbus command NB-R4-V...
  • Page 11: System Commands" Group For General Diagnostics

    ” Every time the current configuration is saved into FLASH memory the value of the Configuration version” param- ” eter increases by one and the prompt changes to cfg#”. The parameter resets to zero by erasing of FLASH. ” NB-R4-V...
  • Page 12: System Commands" Group For Control Of Module Basic Functions

    The command makes possible to send the information message anytime without necessity to change the transmission period or without waiting until the message will be sent spontaneously within the pre-set period. Example: NB-R4-V...
  • Page 13 Commands for setting communication with consumption meters and sensors For setting the encoding system (communication protocol) and parameters of the RS-485 bus interface, there is a group of parameters listed in the configuration commands list in the ”All profiles” sections. These are the following commands: NB-R4-V...
  • Page 14 The ”periode” command with index ”6” is used to set the transmission period of operational messages that the NB-R4-V module sends on its own behalf. The content of these messages is the operational data of the module (uptime, processor temperature, battery voltage...) and data from the history table (see description of the ”hist”...
  • Page 15 DIF 02, VIF 27, INT16, val 355.000 ’Operating time’, multi 0, save id -1 Found DIF/VIF 0c/78, val 20020126.000 Fabrication no. Found DIF/VIF 04/13, val 0.000 m3 Found DIF/VIF 42/6c, val 14111.000 date Found DIF/VIF 44/13, val 0.000 m3 Disable uart, end 60 mbus end 60 NB-R4-V...
  • Page 16 Setting of reading variables from specified registers for the IEC 62056 (”OPTO”) protocol is described in detail in paragraph 3.1.8 ”Commands for setting meters with OPTO protocol”. Example of reading registers of a meter with index ”2” with Modbus encoding using the ”iread” command: NB-R4-V...
  • Page 17: Commands For Setting M-Bus Meters

    Commands for setting M-Bus meters This section contains commands for setting internal inputs of the NB-R4-V module for meters with M-Bus encoding. The commands are listed in the HELP section ”Wired MBUS commands per meter [0 - 5]” and are always entered with the meter index, i.e.
  • Page 18 M-Bus standard (usually corresponds to the device’s serial number). This identifier is used for addressing messages between the NB-R4-V module and the connected meter, so it practically determines which meter is connected to which internal input of the module. The currently set secondary address can be displayed using the command in the format ”sid [index]”...
  • Page 19 Setting the selection of required variables The NB-R4-V module can read up to four variables from each read device. The message in M-Bus format from the given device type may contain many different variables, from which it is necessary to select those variables whose values will be transmitted in INFO messages to the superior system using the commands ”var1”, ”var2”,...
  • Page 20: Commands For Setting Iec 62056 ("Opto") Meters

    IEC 62056-21 standard. This command associates the index of the connected device from the range (0 to 5) in the configuration of the NB-R4-V module with a specific device. The module uses the OID identifier when querying so that it addresses the query to a specific meter and receives only one response (from the queried meter).
  • Page 21 The settings of the register reading can be checked by entering the ”regX” command with an index, without a value. Example: cfg#reg1 0 Reg1 [0] : ’C.1.0’ cfg#reg2 0 Reg2 [0] : ’1.8.1’ Example of changing the setting of read registers (values 1.8.1, 1.8.2 and 4.8.0 will be read, the fourth value will be NB-R4-V...
  • Page 22 This section contains commands for setting internal inputs for reading meters with Modbus protocol encoding con- nected to the NB-R4-V module. The commands are listed in the HELP section ”ModBus protocol commands per meter [0 - 5]” and are always entered with the meter index, i.e. in the form ”command [index] [value]”. Up to four measured variables can be read from devices with the Modbus protocol.
  • Page 23 (3 words) 18 - UINT64 (4 words) For each variant, the data type abbreviation is given and the number of read ”words” is shown in parentheses. We can display the data type variants using the command ”typeX ?”. Example: NB-R4-V...
  • Page 24 The settings of the above described trio of parameters (”reg”, ”type” and ”func”) can be checked by performing a control reading of the register using the ”iread” command described in section 3.1.6 ”Commands for setting communication with consumption meters and sensors”. NB-R4-V...
  • Page 25: Commands For Setting Communication With The Nb-Iot Network

    Server is : ’92.89.162.105’ cfg# Using the ”sport” command, we set the UDP port number of the target server that corresponds to the remote data collection application. Example of setting the target server UDP port number to ”2000” and checking the setting: NB-R4-V...
  • Page 26 APN name is assigned to virtual network operators by the GSM network operator. We cancel the APN setting by entering the value ”.” (dot). Example of setting the APN name to ”cms.softlink”: cfg#apn cms.softlink APN changed from ’’ to ’cms.softlink’...
  • Page 27 Error restart time : 48 hours cfg# Using the ”band” command, you can set the NB-IoT modem frequency band. By default, the most commonly used frequency band B20 in Europe is set (value ”20”). The used modem may support multiple frequency bands, NB-R4-V...
  • Page 28: Commands Of The "Utils" Group For Setting And Checking Basic Module Functions

    The ”Periode” variable is used to set the period of spontaneous sending of information messages. For the NB-R4-V module, this parameter is always set with indices 0 to 6, which have the following meanings: values with indices 0 to 5 are used to set message sending from individual electricity meters in ”online”...
  • Page 29 After turning off encryption, the information ”Data will be unencrypted” will be displayed in the parameter listing (see paragraph 3.1.1). To reduce the number of transmissions (saving battery capacity), the NB-R4-V module allows sending a larger number of previously read values in one message. Such a message then does not contain current measured values, but a set of previously measured values stored in the internal memory of the module (hereinafter ”historical read-...
  • Page 30 One NB-R4-V module can simultaneously connect electricity meters with reading in ”online” mode and in ”history” mode. If we set the value ”periode a x” for the electricity meter with index [a], it is read in ”online” mode with period ”x”.
  • Page 31 Given that the NB-R4-V module can send not only the current counter value but also ”historical” values stored in memory, it must have the correct real-time value (”RTC”) set so that the exact time of measurement can be registered for each stored value.
  • Page 32: Setting Module Parameters Using An Optical Converter

    Figure shows the identification form of the NB-R4-V module (in the yellow frame), the list of available forms (in the green frame) and the administration form (in the blue frame).
  • Page 33: Forms Of The Nb-R4-V Module In The "Softlink Configurator" Application

    Figure 2: Forms of the NB-R4-V module in the ”SOFTLINK Configurator” application (1) The identification form displays basic information about the module (type, modification, serial number, system time) and a button for selecting the configuration form. The administration form displays operational data of the module (uptime, battery voltage, processor temperature).
  • Page 34: Setting Module Parameters From A Remote Computer Using The Reverse Channel

    (OiD 63 = ”1”). This variable is followed by one or more variables for which a change is requested. The NB-R4-V module performs the setting of the requested parameters (update of the specified variables) and sends back a message of type ”RESPONSE” (OiD 63 = ”4”), which contains the values of the changed variables after the change is made.
  • Page 35: Data Messages Of The Nb-R4-V Module

    Structure and types of module data messages The NB-R4-V module is used for reading data from consumption meters via the RS-485 interface and sending current data to a superior automatic data collection system via the NB-IOT service of a GSM operator.
  • Page 36: Commands For Setting Communication With Consumption Meters And Sensors

    3765 RSSI Last RSSI value Input value 1 Current value of variable var1 45628533 Input value 2 Current value of variable var2 12447 Input value 3 Current value of variable var3 Input value 4 Current value of variable var4 NB-R4-V...
  • Page 37: Description Of Trap Type Message

    The type of detected event is encoded in the variable ”Alarm code” (OID 60 - TRAP CODE), where the value of the variable determines the type of event. The current variant of the NB-R4-V type module supports the following types of events: - OID 60 - value ”0”...
  • Page 38: Principle Of Message Encryption

    - value ”2” - Watchdog reset - value ”3” - Error reset - value ”4” - Power reset Example of a ”TRAP” type message with information that the NB-R4-V module has gone through a ”Warm start” type reset (reset given by a regular command): Index...
  • Page 39: Operational Conditions

    NB-R4-V radio modules. General operational risks The NB-R4-V radio modules are electronic devices powered by their own internal battery, which register the status of counters of connected consumption meters. During operation of the device, the following risks are particularly present: 4.1.1...
  • Page 40: The Condition Of Modules On Delivery

    (municipal) authority. Module installation The NB-R4-V radio modules are enclosed in plastic boxes with IP65 or IP68 protection, prepared for wall or pipe mounting. The battery switch, configuration connector, antenna connector and bus connection terminal block are located on the printed circuit board, so access to them is only possible after opening the box.
  • Page 41: Detail Of The Printed Circuit Board Of The Nb-R4-V Module

    (marked in orange). The appearance of the printed circuit board may vary slightly depending on the module modification. Figure 7: Detail of the printed circuit board of the NB-R4-V module NB-R4-V...
  • Page 42: Connection Of A Meter With Rs-485 Output To The Nb-R4-V Module Terminal Block

    Figure shows a detail of connecting the read device to the NB-R4-V module terminal block via the RS-485 bus interface. Figure 8: Connection of a meter with RS-485 output to the NB-R4-V module terminal block The case consists of two parts: the module housing into which the printed circuit board is inserted.
  • Page 43: Diagram Of Connecting Rs-485 Bus Wires To The Nb-R4-V Module Terminal Block

    Figure 9: Diagram of connecting RS-485 bus wires to the NB-R4-V module terminal block In general, the module has a declared degree of moisture resistance (IP65 or IP68) only if it is properly assembled and sealed.
  • Page 44: Replacement Of The Module And Replacement Of The Read Meter

    When replacing a meter read by the NB-R4-V module, where the reason for replacement is a meter failure, expired verification period, or other reason on the meter side, proceed as follows:...
  • Page 45: Dismantling The Module

    4.10 Operation of the NB-R4-V module The NB-R4-V module performs remote reading of meter statuses and sending of radio messages with readings completely automatically. The greatest risks of permanent failure of radio module transmission are associated with the activities of the object user, especially the risk of mechanical damage to the modules when handling objects at the installation site, damage to the module due to water ingress, or the risk of signal shading by a metal object.
  • Page 46: Troubleshooting

    The risk of premature battery discharge can be easily eliminated by respecting the recommendations given in paragraph 4.1.2. Troubleshooting Possible causes of system failures During operation of the NB-R4-V device, failures, malfunctions, or other operational problems may occur, which can be divided into the following categories according to their cause: 5.1.1 Power supply failures The module is powered by an internal battery with a long lifetime.
  • Page 47: Communication Faults With Meters And Sensors

    (see description of bus parameter settings in paragraph 3.1.6; if the bus is physically functional, the setting of communication parameters of the NB-R4-V module for individual devices is correct and in accordance with the settings of individual meters/sensors, but communi- cation over the bus still does not work, the module is probably faulty and needs to be replaced according to paragraph 4.7;...
  • Page 48: Procedure For Determining The Cause Of Failure

    Procedure for determining the cause of failure When identifying the probable cause of a failure, proceed as follows: 1. If no data is being read from any meter/sensor connected to the NB-R4-V module, check the functionality of individual module subsystems in this order: verify the correct setting of the module in the remote reading system database;...

Table of Contents