Advantech WISE-2410 User manual

Frame Data Parser for WISE LoRa modules v1.3.7
1
Advantech Co., Ltd., Copyright 2020
User Manual
Frame Data Parser for
WISE LoRa modules
(JavaScript version)
V1.3.7

Frame Data Parser for WISE LoRa modules v1.3.7
2
Advantech Co., Ltd., Copyright 2020
CONTENTS
1. Introduction....................................................................................................................... 6
1.1. About This Manual .......................................................................................... 6
1.2. Requirements.................................................................................................. 6
1.3. Note................................................................................................................. 6
2. Installations ....................................................................................................................... 8
2.1. Installation Requirement................................................................................. 8
2.2. Operation Steps............................................................................................... 8
3. Data Structure Definition ................................................................................................ 16
3.1. Definitions ..................................................................................................... 16
3.1.1 Temperature.................................................................................................. 17
3.1.2 Accelerometer............................................................................................... 18
3.1.3 Device............................................................................................................ 20
3.1.4 Digital Input................................................................................................... 20
3.1.5 Digital Output................................................................................................ 22
3.1.6 Analog Input .................................................................................................. 23
3.1.7 RS-485 Coil Data............................................................................................ 25
3.1.8 RS-485 Register Data..................................................................................... 26
3.1.9 FFT (Fast Fourier Transform)......................................................................... 27

Frame Data Parser for WISE LoRa modules v1.3.7
3
Advantech Co., Ltd., Copyright 2020
3.1.9.1 FFT in CSV format .......................................................................................... 27
3.1.9.2 FFT in JSON format........................................................................................ 27
3.1.9.3 FFT Data Re-transmission.............................................................................. 28
3.1.10 Axis Data........................................................................................................ 28
3.2. Sample Output .............................................................................................. 29
4. Appendix.......................................................................................................................... 38

Frame Data Parser for WISE LoRa modules v1.3.7
4
Advantech Co., Ltd., Copyright 2020
Change History
Version
Date
Description
1.0
2020/01/02
Initial version.
1.1
2020/01/30
In Chapter 3, add parsing of DI, DO, AI, RS-485 COM
data.
1.2
2020/02/17
In Chapter 3.1.4, add description for DI field: Value and
Status.
1.3
2020/02/25
Add FFT data in Chapter 2 and Chapter 3.1.9.
1.3.1
2020/03/20
In Chapter 3.1.9, modify description for FFT Data.
1.3.2
2020/03/27
In Chapter 3, change FFT Data format
1.3.3
2020/05/11
Add get FFT data re-transmission information(optional)
in Chapter 2.2 and Chapter 3.1.9.3
1.3.4
2020/05/14
In Chapter 3.1.2, add column LogIndex
1.3.5
2020/07/08
In Chapter 3.1.2, edit field name Displacement
1.3.6
2020/09/03
In Chapter 3.1.2, add column Time
1.3.7
2020/09/30
In Chapter 3, change DO output format

Frame Data Parser for WISE LoRa modules v1.3.7
5
Advantech Co., Ltd., Copyright 2020
Chapter 1

Frame Data Parser for WISE LoRa modules v1.3.7
6
Advantech Co., Ltd., Copyright 2020
1. Introduction
1.1. About This Manual
This document describes the Frame Data Parser for Advantech WISE LoRa modules
(ex: WISE-2410, WISE-4610 series). User could use this sample program in Node-Red
to parse frame data of WISE LoRa modules received in LoRa Gateway. WISE-2410 is a
vibration sensor with LoRa/LoRaWAN wireless technology provided by Advantech. In
this document, we use Advantech WISE-6610 as the gateway to receive frame data
sent from WISE-2410.
For WISE-2410 vibration sensor, amount of FFT (Fast Fourier Transform) data for
each axis is 800. Each FFT data is 2 bytes. If user configures WISE-2410 to send 3 axis
(X, Y, Z) FFT data, there will be 2400 data which is 4800 bytes.
1.2. Requirements
⚫Web Browser(Google Chrome is recommended)
⚫WISE-2410 or WISE-4610
⚫WISE-6610 LoRa/LoRaWan Gateway with Node-Red installed
1.3. Note
This sample program only works for parsing of single module (LoRa node) data.
Parsing of multiple modules data is not supported. In Node-RED, user must subscribe
one MQTT topic which contains only one module data.

Frame Data Parser for WISE LoRa modules v1.3.7
7
Advantech Co., Ltd., Copyright 2020
Chapter 2

Frame Data Parser for WISE LoRa modules v1.3.7
8
Advantech Co., Ltd., Copyright 2020
2. Installations
2.1. Installation Requirement
First, please establish connection between WISE-6610 and WISE-2410. Then start the
Node-Red service in WISE-6610.
2.2. Operation Steps
1. Open web browser and navigate to Node-Red pages in WISE-6610.
2. In Node-Red, create a new Flow and add MQTT node, JSON node.

Frame Data Parser for WISE LoRa modules v1.3.7
9
Advantech Co., Ltd., Copyright 2020
3. Fill the MQTT server information in MQTT node. One parser function only
support a single node uplink, Topic is the node MAC.
4. Place a Function Node and a Debug node. Then connect all nodes
mentioned above. You will see below figure.

Frame Data Parser for WISE LoRa modules v1.3.7
10
Advantech Co., Ltd., Copyright 2020
5. Use Text Editor to open the JS file provided by this sample and copy all file
content into clipboard.
6. Double click Function node (named “parsePayload” here) and paste all
content of JS file into Function node.

Frame Data Parser for WISE LoRa modules v1.3.7
11
Advantech Co., Ltd., Copyright 2020
7. Please make sure the variable bIsRunNodeRed is set to true. This variable
enables the Node-Red environment setting for this sample program.
8. Click Deploy button in Node-Red. When WISE-2410 sends frame data to
WISE-6610, you will see the parsed output of sample program in the Debug
Tab on the right side.
9. (Optional) Get FFT (Fast Fourier Transform) data in CSV format from MQTT
subscription.
i. Set outputs of function node to 2.

Frame Data Parser for WISE LoRa modules v1.3.7
12
Advantech Co., Ltd., Copyright 2020
ii. Place a MQTT out node and connect it with “parsePayload“ node.
iii. Fill the MQTT server and Topic information in MQTT out node. User
could define MQTT Server and Topic name.

Frame Data Parser for WISE LoRa modules v1.3.7
13
Advantech Co., Ltd., Copyright 2020
iv. Deploy the Node-Red and use software tool (ex: MQTT.fx) to subscribe
this topic. You will get FFT data in CSV format when WISE-2410 sends
FFT data to WISE-6610.
10. (Optional) If packet lost occurs, user could get packet re-transmission
information from MQTT subscription.
i. Set outputs of function node to 3.
ii. Place a MQTT out node and connect it with “parsePayload“ node.

Frame Data Parser for WISE LoRa modules v1.3.7
14
Advantech Co., Ltd., Copyright 2020
iii. Fill the MQTT server and Topic information in MQTT out node.
iv. Deploy the Node-Red and use software tool (ex: MQTT.fx) to
subscribe this topic. You will get data re-transmission information in
JSON format when lost packet. Please refer to Chapter 3.1.9.3 for
JSON definition.

Frame Data Parser for WISE LoRa modules v1.3.7
15
Advantech Co., Ltd., Copyright 2020
Chapter 3

Frame Data Parser for WISE LoRa modules v1.3.7
16
Advantech Co., Ltd., Copyright 2020
3. Data Structure Definition
3.1. Definitions
This sample program parses received LoRa frame data and translates into JSON/CSV
format. Please refer to below table for data definition:
Field Name
Data Type
Description
SequenceNumber
int
Sequence number of frame data
TotalLength
int
Total length of frame data
SourceAddress
string
Source device address
TempHumi
Temperature
Temperature and Humidity.
Please refer to Chapter 3.1.1.
Accelerometer
Accelerometer
Accelerometer. Please refer to
Chapter 3.1.2.
Device
Device
Device Status. Please refer to
Chapter 3.1.3.
DI(channel)
Digital Input
Digital Input. Please refer to
Chapter 3.1.4.
DO(channel)
Digital Output
Digital Output. Please refer to
Chapter 3.1.5.
AI(channel)
Analog Input
Analog Input. Please refer to
Chapter 3.1.6.
RtuCoil(port)-(channel)
Coil Data
RS-485 Coil data. Please refer to
Chapter 3.1.7.

Frame Data Parser for WISE LoRa modules v1.3.7
17
Advantech Co., Ltd., Copyright 2020
RtuRegister(port)-
(channel)
Register Data
RS-485 Register data. Please
refer to Chapter 3.1.8.
FFT
FFT (Fast Fourier
Transform) Data
FFT (Fast Fourier Transform) Data.
Please refer to Chapter 3.1.9.
3.1.1 Temperature
Field Name
Data Type
Description
Range
int
0x0 - Temperature (℃)
0x1 - Temperature (℉)
0x2 - Temperature (K)
0x3 - Humidity (%)
Event
int
2 octets
Bit
Range: 0x0 –0x3
Temp./Humidity
Bit 0
High alarm status
Read 1: high alarm occurred.
0: not occurred
Write 0: clear the high alarm
status
Bit 1
Low Alarm Status
Read 1: low alarm occurred.
0: not occurred

Frame Data Parser for WISE LoRa modules v1.3.7
18
Advantech Co., Ltd., Copyright 2020
Write 0: clear the low alarm
status
Bit 2
Clear Maximum Sensor Value
1: Clear the maximum Sensor
value
Bit 3
Clear Minimum Sensor Value
1: Clear the minimum Sensor
value
Bit 4
Alarm update
Bit 5 ~ 15
(Reserved)
Status
int
0: Normal
1: Sensor failed
SenVal
int
Temperature or humidity value (0.001)
3.1.2 Accelerometer
Field Name
Data Type
Description
LogIndex
int
Index number of logged feature data, raw
data or FFT data
Time
int
The time to start measuring vibration
X-Axis,
Y-Axis,
Z-Axis
Object
X, Y, or Z Axis

Frame Data Parser for WISE LoRa modules v1.3.7
19
Advantech Co., Ltd., Copyright 2020
SenEvent
int
Bit
Range: 0x4
Accelerometer
Bit 0
High alarm status
Read 1: high alarm occurred.
0: not occurred
Write 0: clear the high alarm status
Bit 1
(Reserved)
Bit 2
(Reserved)
Bit 3
(Reserved)
Bit 4
(Reserved)
Bit 5 ~ 15
(Reserved)
OAVelocity
int
OA Value of Vibration Velocity (0.01
mm/sec) (2 Bytes)
Peakmg
int
Peak Value of Acceleration (0.001g or
0.01 m/s2) (2 Bytes)
RMSmg
int
RMS of Acceleration (0.001g or
0.01 m/s2) (2 Bytes)
Kurtosis
int
Kurtosis (0.01) (2 Bytes)
CrestFactor
int
Crest factor (0.01) (2 Bytes)
Skewness
int
Skewness (0.01) (2 Bytes)
Deviation
int
Standard deviation (0.01) (2 Bytes)

Frame Data Parser for WISE LoRa modules v1.3.7
20
Advantech Co., Ltd., Copyright 2020
Peak-to-Peak
Displacement
int
Peak-to-Peak Displacement, unit: um (2
Bytes)
3.1.3 Device
Field Name
Data Type
Description
Events
int
Bit Order
Description
0
Battery low
1
RTC low
2~7
Reserved
PowerSrc
int
Bit Order
Description
0
Power line
1
Battery
2
Solar panels
3~7
Reserved
BatteryVolt
int
The battery voltage, unit: mV.
Time
int
Timestamp
GNSS
Object
Latitude
Longitude
3.1.4 Digital Input
Field Name
Data Type
Description