Manual for WSNBM-AG | FW1

1. Quick installation guide for WSNBM-AG

This manual is applied to the following products:

Item code Hardware version Firmware Version Firmware released date Change information
WSNBM-AG-03S-XA 1 1 25/Oct/2024

Initial firmware version

1.1 Introduction

WSNBM-AG, a CATM1/NBIoT tilt sensor, is a device designed to measure X-axis tilt , Y-axis tilt and detect X-axis & Y-axis shock. The sensor includes acceleration& tilt module to measure XY accelerations  and measure XY tilts. With the lightweight, efficient communication MQTT protocol, the reliable NBIoT/CATM1 connectivity and the powerful controller, the sensor could measure and transmit real-time tilt data (up to 100 Hz measurement frequency) with minimal overhead. Real-time data from tilt sensors facilitate to identify abnormal tilt of any object such as a Tower, Building, Tree, Electricity Tower, Telecom Tower, Bridges... 

WSNBM-AG-H1-Daviteq-CAT-M1-NB-IoT-Tilt-Sensor.png

1.1.1. The MQTT sensor's system architecture

 

WSNBM-H4---CAT-M1-NB-IoT-Sensor.jpg

System components:

  1. Sensors: publish the data messages to the broker and subscribe request of configuration change messages from the application
  2. MQTT broker: is the server that receives the data messages from the sensors then route them to the application. In addition, the broker also receives request of configuration change messages from the application and then route them to the sensor
  3. MQTT application: subscribe the data messages from the sensor and publish request of configuration change messages to the sensor
1.1.2. How to set up the MQTT system?

Please follow these steps:

1.2 Application Notes

1.2.1. Applications List

Facility Monitoring, Flood Monitoring, Infrastructure Monitoring, Level Monitoring, Machine Health Monitoring, Safety Monitoring, Tilt Monitoring

1.1.2 Application Notes

1.3 When does device publish the topic?

The device will publish the topic following cases to MQTT brokers:

Case 1: When device is power-up, the device will publish the first topic called START_UP. The payload will tell the user the full device configurations and device health statuses.

Case 2: In every interval time (pre-configured), for example, 24 hours, it will publish the topic called HEARTBEAT. The payload will tell the user the full device configurations and device health statuses.

Case 3: If users want to get the value of device configurations and device health immediately, user could force the device to publish the CONFIG-HEALTH-CHECK topic. The device could be forced by applying the magnet key in more than 5s.

Case 4: During the commissioning, testing, or calibration sensor, the user can force the device to publish the topic to get the data immediately. This topic is called FORCE. The payload will provide data like raw measured value, scaled measured values, and device health. It can be forced by applying the magnet key on the reed switch in 1s;

Case 5: Then, in every interval time (pre-configured), for example, 10 minutes, it will publish the topic called CYCLE. The payload will tell the user the following data like measured values and device health. To change the cycle of data sending, you can change the value of the CYCLE_PERIOD parameter. 

Case 6: If XY tit alarms are enable, when difference between average XY tilt for number of samples and corresponding tilt reference are greater or lower than corresponding tilt thresholds during number of sequential readings for alarm on, the device will publish TILT-ALERT topic. In addition, if the alert last more than period of alert cycle, the device will publish next TILT-ALERT topics. The payload contains values of tilts, tilt difference, alert period, alert cycle and the axis causing the alert.

Case 7: If XY acceleration alarms are enable, when XY acceleration for number of samples are greater or lower than corresponding acceleration thresholds during number of sequential readings for alarm on, the device will publish SHOCK-ALERT topic. In addition, if the alert last more than period of alert cycle, the device will publish next SHOCK-ALERT topics. The payload contains values of accelerations, alert period, alert cycle and the axis causing the alert.

Case 8: If the application requests to change device configurations, the application will publish the CONFIG-REQUEST topic to the MQTT broker and the device subscribe the CONFIG-REQUEST topic. After that, the device will change the configuration as request in the CONFIG-REQUEST topic and publish CONFIG-RECEIPT topic.  The payload of CONFIG-RECEIPT topic contains the result of the configuration changes.

1.4 Default Configuration

Please refer to the END USER DEFAULT column in the memory map file at the section 1.9 Payload Document and Configuration Tables

1.5 Power Supply

Main power supply

Note: The configuration cable must be plugged out the configuration port before supplying the external power

Backup power supply

WSNBM-SSM-H6----Daviteq-CAT-M1-NB-IoT-Seismic-Sensor.jpg

 

Note: The configuration cable must be plugged out the configuration port before inserting the batteries to the device.

Wiring of main power supply to M12 female connector for external power supply

WSPLR--LC---H16-LoRaWAN-Load-cell.png

Note:

Procedures to insert batteries

Daviteq-CAT-M1-NB-IoT-Sensor.png

WSNBM-SSM-H16----Daviteq-CAT-M1-NB-IoT-Seismic-Sensor.PNG

WSNBM-SSM-H14----Daviteq-CAT-M1-NB-IoT-Seismic-Sensor.png

 

Note:
The configuration cable must be plugged out the configuration port before inserting the batteries.

Power LEDs 

External Power LED : ON when external power is applied; OFF when no external power is applied

Charge LED: ON when external power supply is greater than 7.2 V to charge the batteries. If the the batteries is fully charged, the LED is OFF.

WSNBM-SSM-H19----Daviteq-CAT-M1-NB-IoT-Seismic-Sensor.PNG

1.6 What's in the Package?

WSNBM-SSM-H18-Daviteq-CAT-M1-NB-IoT-Sensor.png

1.7 Guide for Quick Test

The device can be connected quickly to MQTT broker by the following steps.

Step 1: Prepare the values of communication settings:
  • MQTT broker's settings: host, post, user, password CAT file (if applicable), QoS
  • Cellular settings: CAT M1/NB IoT, frequency bands

Step 2: Install the antenna to the main device by screwing it clockwise

Step 3: Configure on the sensor the MQTT configurations (host, port, user, password, CA file, SSL on/off, QoS, message retain), CAT M1/NB-IoT configurations (network category, frequency bands, RAT search sequence) with offline tool and the sensor template. Refer to section 3.2 CONFIGURATION for details of configuration. 
Step 4: Insert the CAT M1/NB-IoT SIM to the sensor with following step
  • Open the device upper housing by removing 4 screws
  • Insert the SIM to the device: Push the SIM holder cover slightly, open the SIM holder cover, insert the SIM to the holder, then close the SIM holder cover and then push the SIM holder cover back to origin position. Details as in below video

Step 5: Insert the 6 rechargeable batteries into the device. Please refer section 1.5 Power Supply, sub-section Procedures to insert batteries for details

Step 6: Supply external power 9V minimum 1A to the device

  • Plug M12 connector of provided power supply cable to M12 connector on the device
  • Plug/Supply external power supply from 9V power adapter or 9V solar panel to power connector of provided power supply cable

Step 7: After supplying the power, the device will publish topics to the MQTT broker. The application subscribes the topics and decode the payload to get measured values. Details of topic name and payload is at Section Section 1.9 Payload Document and Configuration Tables.

1.8 Installation and Wiring

1.8.1 Installation drawings

Dimension drawings for installation as below

WSNBM-SSM-H5----Daviteq-CAT-M1-NB-IoT-Seismic-Sensor.jpg

1.8.2 Check list for installation

Please follow the checklist below for a successful installation:

1. Have you studied the dimensions of the device as above drawings?
2. Have you tested and make sure the device have been connected successfully as Section "1.7 Guide for Quick Test" above?
3. Have the device been configured properly as per Section 3.2 below?
4. Have the device been calibrated or validated as per Section 3.3 below?
5. Then you can start to install the device at site. Please check the following Installation Notes for Sensor Part (if available) before installation.

1.8.3 Selection for installation location

1.8.4 Sample installation

 

WSNBM-H3-CAT-M1-NB-IoT-Sensor.jpg

WSNBM-H2-CAT-M1-NB-IoT-Sensor.jpg

1.9 Payload Document and Configuration Tables

Please click below link for:

Click Payload document and configuration table to download Payload Document and Configuration Tables

 

1.10 How to connect device to MQTT Broker

Please find below the examples of adding Daviteq's MQTT device to the following MQTT broker:

 

2. Maintenance for WSNBM-AG

2.1 Troubleshooting

Please find below steps to identify the problems from Communication Part or Sensor Part:

2.1.1. Troubleshooting for Communication

 

2.1.2. Troubleshooting for Sensor Part (if available)

 

2.2 Maintenance

There is no requirement for maintenance of the Hardware of the sensor

3. Advanced guide for WSNBM-AG

3.1 Principle of Operation

3.1.1. Components of WSNBM-AG | FW 1

Daviteq CAT-M1/NB IoT Seismic Sensor comprises 03 parts linked internally:

• XY acceleration & XY tilt measurement module

• Device controller

• CAT-M1/NB IoT modem

3.1.2. The parameters in published topic name
    1. STARTUP
    2. HEARBEAT
    3. CONFIG-HEALTH-CHECK
    4. FORCE
    5. CYCLE
    6. TILT-ALERT
    7. SHOCK-ALERT
    8. CONFIG-RECEIPT
3.1.3. Primary output values in the payload of published topics
3.1.4. Secondary output values in the payload of published topics

Below output values are useful for device maintenance and troubleshooting.

3.1.5. The parameters in subscribed topic name
3.1.6. Parameters in the payload of subscribed topic name
3.1.7. Device operation principle description

The device measures the value of X/Y tilt every MEASUREMENT_CYLCE (Maximum MEASUREMENT_CYLCE is 10 milliseconds (100 Hz)). Based on tilt measured value, the device calculates moving (rolling) AVG, MIN, MAX during corresponding NUM_OF_NUMBER and the results are sampleAvgXTilt, sampleAvgYTilt, sampleMinXTilt, sampleMinYTilt, sampleMaxXTilt, sampleMaxYTilt parameters.

If difference between sampleAvgXTilt/sampleAvgYTilt and referenceXtilt/referenceYtilt are greater than corresponding DIFFERENCE_AVG_TILT_HIGH_ALARM_THRESHOLD or are less than DIFFERENCE_AVG_TILT_LOW_ALARM_THRESHOLD during corresponding SEQUENCE_NUM_FOR_HI_ALARM_ON, the device will publish first TILT-ALERT topic and TILT_ALARM_FLAG will be set to 1. During TILT_ALARM_PERIOD (fastest 1 minute) since first alarm, if difference between sampleAvgXTilt/sampleAvgYTilt and referenceXtilt/referenceYtilt return to the normal range during corresponding SEQUENCE_NUM_FOR_TILT_ALARM_OFF, the TILT_ALARM_FLAG will be set to 0. After TILT_ALARM_PERIOD, if TILT_ALARM_FLAG=1, the device will publish the second TILT-ALERT topic. The device handle tilt alarms for sampleAvgXTilt, sampleAvgYTilt separately. referenceXtilt/referenceYtilt are the values of sampleAvgXtilt/sampleAvgYtilt when SET_REF_POS_FOR_TILT_ALARM is set to 1. DIFFERENCE_AVG_TILT_HIGH_ALARM_THRESHOLD must be greater than DIFFERENCE_AVG_LOW_ALARM_THRESHOLD.

The device measures the value of X/Y accelerations every MEASUREMENT_CYLCE (Maximum MEASUREMENT_CYLCE is 10 milliseconds (100 Hz)) and the results are measureXAcceleration, measureYAcceleration parameters. If measureXAcceleration/measureYAcceleration are greater than corresponding ACCELERATION_HIGH_ALARM_THRESHOLD or less than corresponding ACCELERATION_LOW_ALARM_THRESHOLD during corresponding SEQUENCE_NUM_FOR_ACCELERATION_ALARM_ON, the device will publish first SHOCK- ALERT topic and ACCELERATION_ALARM_FLAG will be set to 1. During ACCELERATION_ALARM_PERIOD (fastest 1 minute) since first alarm, if measureXAcceleration/measureYAcceleration return to the normal acceleration range during corresponding SEQUENCE_NUM_FOR_ACCELERATION_ALARM_OFF, the ACCELERATION_ALARM_FLAG will be set to 0. After ACCELERATION_ALARM_PERIOD, if ACCELERATION_ALARM_FLAG=1, the device will publish the second SHOCK-ALERT topic. The device handle acceleration alarms for measureXAcceleration, measureYAcceleration separately.

The device publishes TILT alert, ACCELERATION alert, startup, heartbeat, config health check, force, cycle topic and config receipt topics. The sensor publishes the heartbeat topic, and cyclic data topic (fastest 1 minute) regularly. When the device is powered up, it publishes the startup topic. When the device is forced by magnetic key within 1 second the device publishes the force topic. When the device is forced by magnetic key within 5 second the device publishes the config health check topic. After the device subscribes to the config change request topic from the application, the device will publish the config receipt topic. When tilt/acceleration alert occurs, the device publishes corresponding alert topics.

The startup, heartbeat, the config health check topic contains information of current full configurations, and device health information. The force data topic contains information of device health information and Avg/Min/Max measured tilt during NUM_OF_SAMPLE. The cycle data contains information of device health information and measured Avg/Min/Max Tilt during a cycle. Config receipt topic includes configuration parameter address, the configuration parameter length, request to change configuration value, and changed configuration value.

Tilt alert topic includes information of sampleAvgX/YTilt, alert axis(X,Y), alert status (high, low none), alert period, number of alert cycle. Acceleration alert topic contains information of measureX/Yacceleration, alert axis, alert status (high, low, none), alert period, number of alert cycle.

1.3.8 Configuration for tilt alarm

Follow below steps to configure tilt alarm:

Step 1:

Enable alarm for X-axis tilt via offline or online :

Chang the relevant settings for below configurations:

Refer the memory map at section 1.9 Payload Document and Configuration Tables for meaning of these configurations

Enable alarm for Y-axis tilt via offline or online :

Change the relevant settings for below configurations:

Refer the memory map at section 1.9 Payload Document and Configuration Tables for meaning of these configurations

Step 2: 

Install the device at site

Step 3: 

Write SET_REF_POS_FOR_TILT_ALARM =1 online or offline to set the current position as reference position to detect tilt alarm. After finishing, this setting will be back to 0 automatically. The alarm will be triggered based on the difference between the sampled tilts and referenced tilts.

3.1.9 Calibration for tilt

The tilt sensor is calibrated at 3 calibration positions:
1. X tilt and Y tilt equal 0 degrees.
2. X tilt equals +90 degrees.
3. Y tilt equals +90 degrees.

After fixing the device at above positions, please write the TILT_CALIB_ENABLE to 1  by offline or online (downlink ) to calibrate the sensor. After finishing, TILT_CALIB_ENABLE will be back to 0 automatically.

3.1.10 Offset the tilt value

Enable to offset X tilt and Y tilt value at current position to 0 degrees by set OFFSET_TILT_ENABLE to 1. After finishing, this value will be back to 0 automatically. The offset function could be canceled by set OFFSET_TILT_ENABLE to 2. After finishing, this value will be back to 0 automatically.

Please check the Payload document to understand clearly about uplink messages, downlink messages, meaning of parameters for configuration...

 

3.2 Configuration

3.2.1. How to configure the device?

Sensor configuration can be configured in 02 methods:

​Method 1: Online configuring via Subscribing CONFIG-REQUEST topic from MQTT Application.

Method 2: Offline configuring via Offline cable.

 
3.2.2 Which Parameters are configured?

Please check Part E. MEMORY MAP in Section 1.9 Payload Documents above.

3.2.3 Online configuring via subscribing CONFIG-REQUEST topic from MQTT Application.

Please refer Part C. SUBSCRIBE TOPIC in Section 1.9 Payload Documents above.

3.2.4 Offline configuring via Offline cable.

Please download the Configuration Template File of this sensor to be used in Step 4 below.

Click Download CSV file to download the Configuration Template File

Instructions for offline configuration of the Seismic sensors. Please follow the following steps.

Prepare equipment and tools


The following items must be prepared for configuration.

Download and launch Modbus configuration software 

Click Modbus configuration software to download the software

After downloading the software, unzip the file named  Modbus Configuration.zip and then copy the extracted folder to the storage drive for long-term use. 

offline-tool-1.png

Note: The software only runs on Microsoft Windows OS (Windows 7 and above)

Connect the cable and configure the sensor

Step 1:

Connect the PC to the Battery Pack using the configuration cable and converter cable

- Use the configuration cable (Item code: TTL-LRW-USB-01).

uart.png

- Connect the USB-A plug into the USB-A socket of the PC.

usb-A-latop.png

Step 2: 

On the configuration software, choose the relevant Port (the USB port which is the cable plugged in) and set the BaudRate: 115200, Parity: none

Step 3:

Click Connect button to connect the software to the sensor. After successful connection, the Connected status will show on the software.

Offline-tool-2.png

Step 4:

Import the configuration template file of the sensor (as above link) to the software: click menu File/ Import New and then browse the relevant sensor template file (csv file) and click Open to import the template file.

Each sensor type has its own template file. Refer to the sensor's manual to download the correct file.

Step 5: Open the housing of the sensor and quickly plug the connector of the configuration cable into sensor's modbus configuration port. After plugging the connector, the software will read the parameter values automatically.

Daviteq-CAT-M1-NB-IoT-Sensor--h12.png

- Open the housing of the sensor.

WSNBM---CAT-M1-NB-IoT-sensor-H10-(1).jpg

- Plug the cable connector into sensor's Modbus configuration port.

Note: this port is located at a different location, depends on the sensor type 

Step 6: Read the current value of the parameter with function 3

Offline-tool-GUI-1.PNG

Step 7: Write the new setting to the parameter with function 16

Offline-tool-GUI-2.PNG

For some critical parameters of the sensor, the password in "password for setting" must be written before writing the new settings to these parameters.

Only read/write registers are allowed to write.

Troubleshooting of offline configuration

No. Phenomena Reason Solution
    1 The status on the software always shows Disconnected although the configuration cable is connected to the PC The selected COM port is incorrect Select the correct COM port to which the configuration cable connects to PC
The configuration cable is defective  Check the configuration cable
    2 The software reads no value after importing the right template and connecting the right cable. The cable is defective or lost connection Check or replace the new configuration cable
The USB port is defective Check USB port
There is no power supply to the sensor via configuration cable Check the power line of the cable
The sensor or sensor port is defective Check the sensor and sensor port
    3 No COM port appears in the Port list No configuration cable is plugged into the PC Plug the cable to the PC
The cable driver is not installed on the PC Install the driver for the PC
    4 The parameter table on the software is empty The template file has not been imported Click menu File and sub-menu Import New to import the template file
    5 The parameter table on the software does NOT match the memory map table of the sensor. The wrong template file was imported. Go to the correct manual page of the product and download the right template file, then import the template file into the software.

3.3 Calibration/ Validation

3.3.1 How to force sensor to send data for calibration 

The device can be triggered to send data to the gateway immediately by using the magnetic key to touch the reed switch point on the housing within 1 second as below figures:

 
WSLRW-LC---H15-LoRaWAN-Load-Cell-Sensor.png
 

Note:

Upon transmitting the data to the gateway using the magnetic key, the timer for the transmission time interval will be reset.

The minimum time interval between two manual triggers is 15 seconds. If the interval is less than 15 seconds, data transmission will not occur.

3.3.2 Calibration for tilt

The tilt sensor is calibrated at 3 calibration positions:
1. X tilt and Y tilt equal 0 degrees.
2. X tilt equals +90 degrees.
3. Y tilt equals +90 degrees.

After fixing the device at above positions, write the TILT_CALIB_ENABLE to 1  by offline or online to calibrate the sensor. After finishing, TILT_CALIB_ENABLE will be back to 0 automatically.

4. Product Specifications for WSNBM-AG

4.1 Specifications

MEASUREMENT  
Tilt Sensor Built-in advanced accelerometer to deliver tilt angle measurement of XY
Tilt Measurement range  ±90° 
Tilt Resolution ±0.001°
Tilt Repeatability ±0.010°
Sensor sampling rate 100Hz max
COMMUNICATION  
Host connectivity CAT-M1/NB IoT Global Bands
Antenna External antenna
Protocol MQTT, JSON payload
Data sending modes interval time, alarm and manually triggering by magnetic key
Alarm function for tilt and acceleration
Power Supply External power 5-10V 1A minimum for main power and 6xAA rechargeable battery 1.2V/2000mAh (recommend Panasonic Eneloop Standard) for auxiliary power, M12 connector
Ambient working temperature -40 .. 85℃ (depends on battery specification)
Housing Anodized A6061 Aluminum, Carbon-color, IP67
Bracket :2 x 304SS Bracket for base mount or wall mount
Size | Net weight H110xW110xD53 (not including antenna)/ 850g
Mounting type Wall mount

5. Warranty for WSNBM-AG

5.1 Warranty

Below terms and conditions are applied for products manufactured and supplied by the Supplier.

5.1.1 Free Warranty Conditions

Note: One way shipping cost to the Return center shall be paid by Customers.

5.1.2 Paid Warranty

Note: Customers will be subjected to all repairing expenses and 2-way shipping costs. If arises disagreement with the company's determining faults, both parties will have a third party inspection appraise such damage and its decision be and is the final decision.