YOSensi LNRM User manual

YO Modbus
User guide v2.1

YO Modbus User guide v2.1
page 2/33
Release notes
Released
Version
Key changes
25.08.2022
1.0
Initial release.
27.07.2023
2.0
Configuration node description using Yosensi platform
added. Description of MODBUS communication protocol
Device parameters names and description modified.
Configuration file modified. Changed description of
connecting nodes with Yosensi Management Platform.
26.10.2023
2.1
Added configuration with Yosensi Mobile App, updated
documentation.
www.yosensi.io

YO Modbus User guide v2.1
page 3/33
Content
Release notes 2
Content 3
Product description 4
Overview 4
Physical interfaces 5
LEDs 5
Buttons 5
RS485 interface 6
Specifications 7
Physical 7
Operating conditions 8
Measured values 8
Queries and polls 9
Installation 10
Package contents 10
Safety precautions 10
Installation guide 11
Operation 13
IoT system components 13
Device configuration 14
Configurable parameters 14
Parameters description 18
Configuration node via Yosensi Management platform 21
Configuration node with Yosensi mobile app 26
Connecting node with network 27
Yosensi Management Platform configuration 27
Adding node manually 27
Adding node via Bluetooth 29
Payload description 30
Compliance statements 32
www.yosensi.io

YO Modbus User guide v2.1
page 4/33
Product description
Overview
YO Modbus bridges between the Modbus network and the LoRaWAN. It allows users to read data
via Modbus RTU from slave devices and to send it via LoRaWAN. One YO Modbus device provides
capacity to create up to 150 Modbus queries and to send them in up to 30 different LoRa packets.
These are sent in LoRA packets of up to 5 queries each (i.e. maximum of 30 packets).
Figure 1 Device top view.
Device sticker placed on the right side of the device enclosure contains information about model,
version, LoRaWAN region and 3 parameters important in case of device identification and
configuration:
-DEV EUI: 64-bit unique device identifier in a LoRaWAN network,
-DEV ADDR: address required to connect via ABP activation type to LoRaWAN,
-BLE MAC: bluetooth physical address.
Figure 2 Device sticker.
www.yosensi.io

YO Modbus User guide v2.1
page 5/33
Physical interfaces
LEDs
YO Modbus communicates its current behavior to the user by RGBW LED placed on the top of the
device shown on figure 1.
DIODE STATUES INTERPRETATION
BEHAVIOUR
COLOUR
DEVICE STATUS
Single flash
Green
General: device is working correctly (power and memory).
Single flash
Red
General: device is working incorrectly (power and memory).
LoRaWAN communication: failed to receive an
acknowledgement from LoRaWAN Server within specified
timeout.
Single flash
White
LoRaWAN communication: LoRaWAN packet sent \
confirmation from LoRaWAN Server after receiving the packet.
Slow flashing
Blue
BLE communication: connection to the device via BLE
(configuration).
Rapid flashing
Blue
LoRaWAN communication: connecting to LoRaWAN network.
Continuous lit
Orange
Term diode: Terminating resistor connected.
Rapid flashing
RS485
Red
RX/TX diode: RS485 packet sent
Green
RX/TX diode: RS485 packet received
Buttons
YO Modbus is equipped with one reset button under the interference status diode RX/TX shown on
the device top view. It is possible to press it with a thin pin.
www.yosensi.io

YO Modbus User guide v2.1
page 6/33
Figure 3 Connection the YO Modbus device with slave device.
RS485 interface
When connecting RS485 nodes to YO Modbus, connect the A+ line to the RS485 A bus and B− to the
RS485 B bus. GND connects to the ground terminal of the RS485 bus.
This device can be supplied with 6–30 VDC or 5–21 AC.
Optionally, a protective earth cable can be connected. To prevent loop currents, an Earth connection
should be made at only one point on the network.
Line topology may or may not require terminating loads depending on the length of cable used. The
impedance of the termination load should match with line impedance on both ends. The termination
load is usually 120 Ωon both sides, although the device contains an in-build terminating resistor RT.
YO Modbus communicates by sending queries to each device and converting polls, with data from
each slave, into LoRa frames for relay to the application server. Prior to communication between
nodes and the master, it is necessary to configure the serial transmission in the YO Modbus device.
For this, you will need to know the slave addresses and individual registers for reading data.
www.yosensi.io

YO Modbus User guide v2.1
page 7/33
Specifications
Physical
Figure 4 Dimensions of the device.
PHYSICAL SPECIFICATION
Dimensions
Height: 90 mm
Width: 17,5 (4 pole) mm
Depth: 58 mm
Colour
Light grey
Mounting method
35 mm DIN rail
Vertical (can be screwed to the wall)
Enclosure material
Polycarbonate
Fire resistance class
UL94-VO
Level of protection
IP20
Weight
90 g
www.yosensi.io

YO Modbus User guide v2.1
page 8/33
Operating conditions
OPERATING CONDITIONS
Temperature
0° to 70°C
Humidity
0 to 90%
Placement
Indoor use
Power supply
6 - 30 V DC
5 - 21 V AC
Power consumption
Typical: 12 mA DC (12 V DC)
Maximum: 120 mA DC (12 V DC)
Measured values
Internal voltage is used to monitor device condition to detect anomalies (like sudden drop) or its
current condition from voltage drop over time below the initial voltage rating.
Figure 4 Internal voltage chart.
www.yosensi.io

YO Modbus User guide v2.1
page 9/33
Queries and polls
YO Modbus can request up to 150 different queries from slave devices. Establishing communication
requires advance knowledge of the device’s starting registers, slave address and function codes. This
device supports the following read functions:
●01 (0x01) Read coils
●02 (0x02) Read discrete inputs
●03 (0x03) Read holding registers
●04 (0x04) Read input registers
The query data are read by Modbus RTU and sent by LoRaWAN. Each LoRa packet contains data
from the read registers. One LoRa packet can contain 5 five user-created polls, each up to 4 bytes.
NOTE
More information about queries and polls can be found in the device configuration
section.
Figure 4 Measurements from register 0x1000.
Figure 5 Measurements from register 0x106e.
www.yosensi.io

YO Modbus User guide v2.1
page 10/33
Installation
Package contents
1. Device.
2. Warranty card.
3. Antenna.
Safety precautions
SAFETY PRECAUTIONS
SYMBOL
DESCRIPTION
Device is marked with a symbol saying that electrical and electronic
products may not be mixed with unsorted household waste. Remember
that batteries used to power the device must be treated at a specialized
treatment facility.
Remember about possible electrostatic discharge when replacing battery,
connecting input or doing some other operations near inside electronics.
Be careful while handling the device – dropping it may cause damage that will
affect the sensors and other electronics inside.
When installing the device on the wall remember to wear adequate protective
equipment.
To maintain the level of protection device cover screws must be properly
tightened. Device shouldn’t be used without cover.
Any actions inside the device's enclosure must be performed by trained
personnel only.
Clean the device only with damp cloth.
Device is intended for indoor use.
www.yosensi.io

YO Modbus User guide v2.1
page 11/33
Installation guide
1. Mount the device on a 35 mm DIN rail.
Figure 6 Device mounted on 35 mm DIN rail.
2. Screw RS485 protocol communication wires to the device’s A+ and B− terminal blocks.
Optionally, connect cable shielding to the device’s GND terminal block.
Figure 7 Connecting communication wires to device terminal blocks .
www.yosensi.io

YO Modbus User guide v2.1
page 12/33
3. Screw the power supply wires to the device (6–30 V DC, 5–21 V AC). Optionally, connect a
protective earth (PE) cable. Once power is connected, the indicator diodes should behave as
described on physical interfaces of the LEDs.
Figure 8 Connecting power supply to the device .
4. Connect the antenna to the device.
Figure 9 Device with antenna.
www.yosensi.io

YO Modbus User guide v2.1
page 13/33
Operation
IoT system components
Typical IoT systems consist of 3 main elements (Figure 10), brief described below. In order to set
communication, each element must be properly configured.
1. Node – device with sensors and a wireless communication module that gathers data, forms
the payload and sends it to the gateway.
2. Gateway – device similar to routers, equipped with a LoRa concentrator, that receives LoRa
packets and send them to the Internet-connected server.
3. Server – in most cases, a cloud-based service where data is processed, stored, analysed, and
presented in user-friendly ways (via a user interface); Yosensi default and recommended
tools are Yosensi Management Platform (for IoT structure management) and Grafana (for
data presentation).
Figure 10 IoT system components.
Figure 11 Fresnel zone where communication between two antennas can occur.
www.yosensi.io

YO Modbus User guide v2.1
page 14/33
Device configuration
Configurable parameters
A few parameters must be set before sending data to the gateway. The default firmware is configured
in OTAA mode with predefined deveui,appkey (OTAA)and appskey,nwkskey (ABP).
Configuration of the device is stored in a JSON file divided into the following sections:
-info (generic, read only): information about the device,
-lorawan (generic): configuration data for LoRaWAN connection,
-ble (generic): bluetooth settings,
-device (dynamic): individual configuration for a specific device (this section’s structure differs
for each device),
- modbus (dynamic): individual configuration of Modbus RTU communication,
- serial (dynamic): asynchronous serial communication parameters for Modbus RTU protocol,
- timings (dynamic): timings for response and delays between master–slave communications,
- queries (dynamic): queries configured and executed by the user,
- pollstosend (dynamic): polls sent by slave to the master; data collections prepared to send via
LoRaWAN
Sample configuration file for the YO Modbus device.
{
"info": {
"devmodel": "LNRM",
"fwver": "3.6.1",
"loraradio": "SX1261",
"lorawanver": "1.0.2",
"loraregion": "EU868",
"blemacaddr": "0123456789ab"
},
"lorawan": {
"subband": 1,
"nwktype": "public",
"acttype": "otaa",
"otaa": {
"deveui": "0123456789abcdef",
"appeui": "1234009864628194612728",
"appkey": "4321033211204532121238766",
"trials": 3
},
"abp": {
"devaddr": "01234567",
"nwkskey": "0123456789abcdef0123456789abcdef",
"appskey": "000102030405060708090a0b0c0d0e0f"
}
},
"ble": {
"power": 0,
"interval": 1600
},
"device": {
"measinterval": 600
},
www.yosensi.io

YO Modbus User guide v2.1
page 15/33
"modbus": {
"terminationresistor": false,
"driverswitchidletime": 5
},
"serial": {
"baudrate": 9600,
"databits": 8,
"parity": "none",
"stopbits": 1
},
"timings": {
"responsetimeout": 1000,
"delaybetweenpolls": 100
},
"queries": [
{
"name": "01Ph1V",
"slaveaddr": 1,
"funccode": 3,
"startreg": "1000",
"regnbr": 2
},
{
"name": "RunHour",
"slaveaddr": 1,
"funccode": 3,
"startreg": "106e",
"regnbr": 1
},
{
"name": "3PHpwrfctr",
"slaveaddr": 1,
"funccode": 3,
"startreg": "1024",
"regnbr": 1
},
{
"name": "1PHactpwr",
"slaveaddr": 1,
"funccode": 3,
"startreg": "102c",
"regnbr": 2
}
],
"pollstosend": [
{
"cnt": 1,
"out": [
"01Ph1V",
"RunHour",
"3PHpwrfctr",
"1PHactpwr",
]
}
]
}
www.yosensi.io

YO Modbus User guide v2.1
page 16/33
GENERICS PARAMETERS
SECTION
NAME
DESCRIPTION
POSSIBLE
VALUES
DEFAULT
VALUE
READ/
WRITE
info
devmodel
Device name
-
LNRM
R
fwver
Firmware version
-
3.6.1
R
loraradio
Radio chipset model
-
SX12611
R
lorawanver
LoRaWAN stack version
-
1.0.2
R
loraregion
LoRaWAN region
-
EU8681
R
blemacaddr
Bluetooth LE address
-
predefined
R
lorawan
subband
Uplink subband number
Table2
predefined
R/W
nwktype
Network type
public,
private
public
R/W
acttype
Activation type
otaa, abp
otaa
R/W
lorawan
-otaa
deveui
Device EUI (Extended
Unique Identifier)
8 B (HEX)
predefined
R/W
appeui
Application EUI
8 B (HEX)
predefined
R/W
appkey
Application Key
16 B (HEX)
predefined
R/W
trials
Join request trials
1-9
3
R/W
lorawan
-abp
devaddr
Device Address
4 B (HEX)
predefined
R/W
nwkskey
Network Session Key
16 B (HEX)
predefined
R/W
appskey
Application Session Key
16 B (HEX)
predefined
R/W
ble
power
Bluetooth LE transmit power
dBm
04
0
R/W
interval
Bluetooth LE advertising
interval [ms]
MS_INPUT3
1600
R/W
1LoRa radio chipset used defines the LoRaWAN region: SX1261 - EU868; SX1262 - AU915, US915, AS923
2Uplink subband list for specific LoRaWAN regions - UPLINK SUBBAND Table.
3Calculation formula: MS_INPUT = INTERVAL_MS × 1.6.
4Change currently not supported.
www.yosensi.io

YO Modbus User guide v2.1
page 17/33
DEVICE PARAMETERS
NAME
DESCRIPTION
POSSIBLE
VALUES
DEFAULT
VALUE
READ/
WRITE
measinterval
Measuring and sending
interval LoRa [s]
120–999999
600
R/W
MODBUS PARAMETERS
NAME
DESCRIPTION
POSSIBLE
VALUES
DEFAULT
VALUE
READ/
WRITE
terminationresistor
Presence of termination
resistor in RS485 standard
true, false
false
R/W
driverswitchidletime
Delay [ms] of TX and RX
parameters in serial
communication between
devices in the network.
1-100
5
R/W
SERIAL AND TIMINGS PARAMETERS
NAME
DESCRIPTION
POSSIBLE
VALUES
DEFAULT
VALUE
READ/
WRITE
baudrate
Bus speed [bps]
1200, 2400,
4800 ,9600
9600
R/W
databits
Number of data bytes per
packet.
7,8,9
8
R/W
parity
Data integrity validation type
none, odd,
even
none
R/W
stopbits
Last bit type of a one-byte
transmission.
1, 2
1
R/W
responsetimeout
Response timeout from slave
device in [ms].
10–10000
1000
R/W
delaybetweenpolls
Delay [ms] before the next
query.
1–10000
100
R/W
www.yosensi.io

YO Modbus User guide v2.1
page 18/33
POLL AND QUERY PARAMETERS
NAME
DESCRIPTION
POSSIBLE
VALUES
DEFAULT
VALUE
READ/
WRITE
name
Name of query, up to 10
characters
“0-9, A-Z, a-z,_
. ,” e.g.
aB.cD-01
—
R/W
slaveaddr
Number of slave addresses to
communicate with
0–255
1
R/W
funccode
Supported Modbus function
codes
1, 2, 3, 4
3
R/W
startreg
Start register to read data
from
2B (HEX), e.g.
1000
—
R/W
regnbr
Number of words (2 bytes) to
read from registers, begins
from ’startreg’
1–8
1
R/W
cnt
LoRa packet collection index
number. Each packet can
contain 5 queries.
1–30
—
R/W
out
Name of the query to be
transmitted in a LoRa packet.
“0–9 A–Z a–z
. ,”e.g.
aB.cD-01
—
R/W
Parameters description
-nwktype: network type, for setting the device operation to public or private.
-acttype: activation type for setting the device in ABP or OTAA mode.
-deveui, … , appskey: predefined addresses and keys, these parameters are generated using
multiple IDs specific to the particular MCU and are unique for each device. They can be
changed if needed.
-interval: the interval between broadcast packets, used to connect to every BLE receiver
around the device.
-subband: the communication frequency sub-band.
-measinterval: measurement interval [s] between sending LoRa packets.
-teminationresistor: whether a resistor is applied to the end line to prevent signal reflections
for correct signal transmission. Value “TRUE” means that the resistor is installed.
www.yosensi.io

YO Modbus User guide v2.1
page 19/33
-driverswitchiddletime: Delay [ms] from 1 ms up to 100 ms for serial TX and RX parameters
between devices in the network.
-baudrate: information transfer rate bits per second. Supported baud rates are 1200, 2400,
4800 ,9600
-databits: the amount of data in each packet. 7,8,9 formats are not supported with parity
“none” value.
-parity: The parity bit, unlike the start and stop bits, is an optional parameter, used in serial
communications to determine if the data character being transmitted is correctly received by
the remote device.
-stopbits: the last bit of a one-byte transmission, used for timing or synchronization.
-responsetimeout: how long Modbus Poll should wait for a slave device response before
giving up. Default is 1000ms.
-delaybetweenpolls: the minimum delay until the next request is transmitted. Default is
100ms.
-name: name of the query parameter, up to 10 characters. The name can be freely modified by
the user to correspond to the parameter to be read out.
-slaveaddr: address of the target slave device.
-funccode: function code for the Modbus RTU protocol. Value 1 indicates “read coils”, value 2
= “read contacts”, 3 = “read holding registers”, 4 = “read input registers”.
-startreg: starting register, which is the address from which the reading of data from a
particular slave will start.
-regnbr: register number of data to read from the slave. Value “1” means that 2 bytes will be
read, value “2” = 4 bytes will be read over the Modbus network..
-cnt: packet counter index. The YO Modbus device can handle up to 150 queries. Limitation is
5 variables per query.
-out: the query name for output from the slave. Maximum of 5 queries per packet (along with
maximum of 150 queries per Modbus).
www.yosensi.io

YO Modbus User guide v2.1
page 20/33
UPLINK SUBBAND
REGION
DESCRIPTION
POSSIBLE
VALUES
DEFAULT
VALUE
READ/
WRITE
EU868
Sub-band 1; 867.1 - 868.5 MHz; channels 0-7
1
1
R
US915
Sub-band 1; 902.3 - 903.7 MHz; channels 0-7
1
2
R/W
Sub-band 2; 903.9 - 905.3 MHz; channels 8-15
2
Sub-band 3; 905.5 - 906.9 MHz; channels 16-23
3
Sub-band 4; 907.1 - 908.5 MHz; channels 24-31
4
Sub-band 5; 908.7 - 910.1 MHz; channels 32-39
5
Sub-band 6; 910.3 - 911.7 MHz; channels 40-47
6
Sub-band 7; 911.9 - 913.3 MHz; channels 48-55
7
Sub-band 8; 915.5 - 914.9 MHz; channels 56-63
8
AU915
Sub-band 1; 915.2 -916.6 MHz; channels 0-7
1
2
R/W
Sub-band 2; 916.8 - 918.2 MHz; channels 8-15
2
Sub-band 3; 918.4 - 919.8 MHz; channels 16-23
3
Sub-band 4; 920.0 - 921.4 MHz; channels 24-31
4
Sub-band 5; 921.6 - 923.0 MHz; channels 32-39
5
Sub-band 6; 923.2 - 924.6MHz; channels 40-47
6
Sub-band 7; 924.8 - 926.2 MHz; channels 48-55
7
Sub-band 8; 926.4 - 927.8 MHz; channels 56-63
8
AS923
Sub-band 1; 922.0 -923.2 MHz; channels 0-8
1
2
R/W
Sub-band 2; 923.2 - 924.5 MHz; channels 9-17
2
www.yosensi.io