Manual for Sigfox Sensors

Manual for Sigfox sensors - Common parts



What is Sigfox?

Understanding the Sigfox Connectivity Technologies.

Please find this link for understanding Sigfox Connectivity Technologies.Troubleshooting for Sigfox Communication

This is the troubleshooting for Sigfox communication of Sigfox-ready sensors with FW versions listed below:

No.

Phenomena

Reason

Solutions

1

Node does not send RF to the base station periodically, LED does not blink

No power supply or battery ran out

The configuration sending cycle is incorrect

Check that each battery is empty OR not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to the base station according to the alarm, LED does not blink

The alarm threshold values are incorrect and/or disabled alarm function

Running out of the number of alarms set for the day

Check alarm threshold values and alarm enable

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to the base station when activated by the magnetic switch, LED does not blink

The magnetic switch has malfunctioned

Or place the Magnet key in not right position

Locate the correct position for the magnet key

Read the status of the magnetic switch via Modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot receive

Out of the number of RF packages of uplink per day (max 140 packages/day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

Contact manufacturer

6

The node does not send RF and the RF module is hot

Insert the battery in the wrong direction

Electronics got problem

Check battery polarity

7

RSSI is weak and often loses data

Distance between Node and Base station is far or there are many obstructions

Connection to Antenna problem

Check the location of the Sigfox node and distance to the base station

Check the antenna connector in the PCB

8

The measurement values from the sensor do not change and keep constant values for a long time

Sensor got failure

Sensor cable broken

The sensor connector is not connected firmly

Check sensor cable and connector

If the issue still exists, please contact the manufacturer for a warranty or replace the new sensor

Offline configuration for Sigfox Sensors

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Instructions for offline configuration of the Daviteq Sigfox-Ready sensors. Please follow the following steps.

Note: THE SENSOR IS ONLY ACTIVE FOR CONFIGURATION IN THE FIRST 60 SINCE POWER UP BY BATTERY OR PLUGGING THE CONFIGURATION CABLE.

1. Prepare equipment and tools

The following items must be prepared for configuration.

A PC using the Windows OS (Win7 or above versions). The PC is installed with the COM port driver of the Modbus configuration cable (if needed). The driver is at link:

Modbus Configuration Cable COM port driver for PC

and the instruction to install the driver at link: How to install the driver

A Modbus configuration cable;

Tools to open the housing of Sigfox-ready sensors (L hex key or screwdriver)

2. Download and launch Daviteq Modbus configuration software

Click the link below to download Daviteq Modbus configuration software:

https://filerun.daviteq.com/wl/?id=yDOjE5d6kqFlGNVVlMdFg19Aad6aw0Hs

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

Open the folder, double click on the file Daviteq Modbus Configuration Tool Version.exe  to launch the software and the software interface as below:

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

3. Connect the cable and configure the sensor

Step 1: Connect USB plug of Modbus configuration cable to USB socket of the PC

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

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

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

Step 3: Click the “ Connect “ button to connect the software to the sensor. After a successful connection, the connected status(green text) will show on the software.

Step 4: Import the configuration file for the sensor 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.

The sensor is only active for configuration for 60 seconds since plugging the configuration cable or the power supply into the sensor.

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.

- Open the housing of the sensor.

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

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

The sensor is only active for configuration for 60 seconds since plugging the configuration cable or the power supply into the sensor.

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

At the relevant row of the parameter, check box 3 on column FC to read the value of the parameter. The read value is shown on VALUE ON MEMMAP column.

The sensor is only active for configuration for 60 seconds since plugging the configuration cable or the power supply into the sensor. After 60 seconds, the TIME_OUT text will show on EXCEPTION column of the software.

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

Double click on the column VALUE TO WRITE of the parameter and input the new setting of the parameter

Uncheck the tick on the FC column of the parameter, click on the arrow, select 16 and then check on the FC column to write a new setting to the parameter. The WRITE_OK text will show on EXCEPTION column if the software successfully writes the setting.

Repeat step 6 to read the setting of the parameter for checking.

The sensor is only active for configuration for 60 seconds since plugging the configuration cable or the power supply into the sensor. After 60 seconds, the TIME_OUT text will show on EXCEPTION column of the software.

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.

4. Troubleshooting

No.

Phenomena

Reason

Solutions

1

The status on the software always shows Disconnected although the configuration cable is connected to the PC

The selected COM port is incorrect.

The cable is defective

Select the correct COM port to which the configuration cable connects to PC

Check the cable

2

The software reads no value after importing the right template and connecting the right cable.

The cable is defective or lost connection

The USB port is defective

There is no power supply to the sensor via configuration cable

The sensor or sensor port is defective

Check or replace the new configuration cable

Check USB port

Check the power line of the cable

Check the sensor and sensor port

3

No COM port appears in the Port list

No configuration cable is plugged into the PC

The cable driver is not installed on the PC

Plug the cable to the PC

Install the driver for the PC

4

The parameter table on the software is empty

The template file has not been imported

Go to File/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.

5. List of Configuration Template Files for various Sigfox-Ready Sensors

Please find this link for the template file of each Sigfox-Ready sensor.

END.

List of Configuration template files of Sigfox-Ready Sensors

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Each Sigfox-Ready Sensor has a template file for Offline configuration. Please find below the list.

SKU#

Product Description

FW Ver.

Link to download Configuration Template File

Remarks

WSSFC-AC

Sigfox-Ready AC Current Sensor

1.0

Template file for WSSFC-AC-FW 1.0-HW 1.0

WSSFC-AC

Sigfox-Ready AC Current Sensor

3.0

Template file for WSSFC-AC-FW 3.0

WSSFC-AG

Sigfox-Ready Accelerometer-Gyro Sensor

1.0

Template file for WSSFC-AG-FW 1.0- HW 1.0

WSSFC-ATH

Sigfox-Ready integrated ambient humidity and temperature sensor

1.0

Template file for WSSFC-ATH-FW 1.0- HW 1.0

WSSFC-CAP10

Sigfox-Ready high precision capacitance fuel level sensor

1.0

Template file for WSSFC-CAP10-FW 1.0 HW 1.0

WSSFC-CO2

Sigfox-Ready Industrial CARBON DIOXIDE GAS SENSOR, NDIR Type

1.0

Template file for WSSFC-CO2-FW 1.0- HW 1.0

WSSFC-LPC

Sigfox-Ready People counter, Lidar technology

1.0

Template file for WSSFC-LPC-FW 1.0- HW 1.1

WSSFC-LPC

Sigfox-Ready People counter, Lidar technology

2.0

Template file for WSSFC-LPC-FW 2.0- HW 2.0

WSSFC-G4F-NH3

Sigfox-Ready Gas Sensor, 4-Seri, Ceiling mount type, NH3

6.0

Template file for WSSFC-NH3-FW 6.0-HW 2.0

WSSFC-PPS

Sigfox-Ready Process Pressure Sensor

1.0

Template file for WSSFC-PPS-FW 1.0- HW 1

WSSFC-ULC

Sigfox-Ready Ultrasonic level sensor for liquid or flat surface

1.2

Template file for WSSFC-ULC-FW 1.2- HW 1.1

WSSFC-V1A

Sigfox-Ready Single Axis Vibration Sensor, 10 KHz Piezo technology

1.0

Template file for WSSFC-V1A-FW 1.0- HW 1.1

WSSFCEX-PPS

Sigfox-Ready Process Pressure Sensor with Exd approval

1.01

Template file for WSSFCEX-PPS-FW 1.01-HW 1.0

WSSFCEX-GHC

Sigfox-Ready Flammable Gas Sensor with Exd approval

2

 Template file for WSSFCEX-GHC-FW 2-HW 1

WSSFC-ULA

Sigfox-Ready Ultrasonic level for solid waste

2

 Template file for WSSFC-ULA-FW 2- HW 2

END.Common notes in installation of Sigfox-Ready Sensors

The common instructions for all kinds of Daviteq Sigfox-Ready Sensor. Please see below.

1. HOW DO YOU GET A STRONG RF SIGNAL?

To maximize the transmission distance, the ideal condition is Line-of-sight (LOS) between the Sigfox-Ready sensor and the Sigfox Base station. In real life, there may be no LOS condition. However, the Sigfox-Ready sensor still communicates with the Base station, but the distance will be reduced significantly.

DO NOT install the wireless sensor or its antenna inside a completed metallic box or housing because the RF signal can not pass through the metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, and cement…is acceptable.

2. INSTALL BATTERIES FOR SIGFOX-READY SENSOR

2.1 INSTALL BATTERIES FOR SIGFOX-READY SENSOR WITH BLUE BOX HOUSING

Steps for battery installation:

Step 1: Using L hex key to unscrew M4 screws at the side of the housing and carefully pull out the top plastic housing in the vertical direction

Step 2: Insert 02 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing and locking by L hex key

ATTENTION:When reinstalling the cover, pay attention to put the PCB edge into the middle slot of the box inside as shown below)

2.2  INSTALL BATTERIES FOR SIGFOX-READY SENSOR WITH WHITE BOX HOUSING, 6 X AA BATTERIES (SENSOR -LPC)

Steps for battery installation:

Step 1: Use flat head screws to push into 2 reed joints

Step 2: Open the housing, then insert 06 x AA 1.5VDC battery, please take note of the poles of the battery

ATTENTION: REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing (Please note the 2 reed joints)

2.3  INSTALL BATTERIES FOR SIGFOX-READY SENSOR WITH BLACK BOX HOUSING, 2 X AA BATTERIES (SENSOR -ULA)

Steps for battery installation:

Step 1: Use a screwdriver to open the 4 screws on the underside of the housing

Step 2: Open the housing, then insert 02 x AA 1.5VDC battery

ATTENTION: REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the plastic housing and locking the 4 screws by screwdriver

2.4  INSTALL BATTERIES FOR SIGFOX-READY SENSOR WITH EXD-APPROVED HOUSING WSSFCEX-...

Depends on the design of each device. Each device may need 1 pc of Type C or Type D battery. Please check the specification of that device. We recommend the below batteries to be used with our devices.

Steps for battery installation:

DANGER:DO NOT REPLACE BATTERY AT HAZARDOUS LOCATION!DO NOT OPEN THE COVER AT HAZARDOUS LOCATION!ONLY OPEN COVER AND REPLACE BATTERY IN SAFE AREA!

Step 1: Turn the front cover of the sensor counter-clockwise;

Step 2: Carefully take out the front cover of the sensor

Step 3: Insert the  battery, please take note the polarity of battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 4: Turn the front cover of the sensor clockwise to close fully.

NOTES:Using 2mm hex key to lock the cover to prevent the unattended opening.

3. MOUNTING FOR SIGFOX-READY SENSOR

3.1 MOUNTING FOR SIGFOX-READY SENSOR WITH BLUE BOX HOUSING

The following are the steps for the Sigfox-ready sensor with a Blue box housing design.

Step 1: Install the bracket on the sensor

Step 2: Determine the mounting position and secure the sensor with the included screws

Step 3:Grounding the sensor

3.2 MOUNTING FOR SIGFOX-READY SENSOR WITH WHITE BOX HOUSING

3.3 MOUNTING FOR SIGFOX-READY SENSOR WITH EXD-APPROVED HOUSING

4. ADDING A SIGFOX-READY SENSOR TO SIGFOX BACK-END SYSTEM

This instruction is applied to all kinds of Sigfox-Ready sensors produced by Daviteq.

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

Manual for Sigfox Sensors - Type 1

Sigfox Sensors - Type 1 are the sensors like Lidar People Counter... the sensor with white box rectangular housing for ceiling mount or wall mount.

Manual for Sigfox-Ready Ultrasonic Level Sensor for Trash bin - WSSFC-ULA | FW2



THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Thank you very much for choosing Daviteq Wireless Sensors. We are the leading wireless sensor manufacturer in the World. We have a wide range of wireless sensors which support different connectivity like LoRaWAN, Sigfox, Sub-GHz, NB-IoT...Please find out more information at this link.

This manual is applied to the following products

Item code

HW Version

Firmware Version

Remarks

WSSFC-ULA-01

2

2

Information Changes in this version v.s previous version

Item

Changes

Changed by

Changed Date

Approved by

Approved Date

1

Initial version

D.Q.Tuan

01-08-2022

N.V.Loc

24-08-2022

To use this product, please refer step by step to the below instructions.

Operating Principle

Uplink Payload

Battery

Connect to Sigfox Network

Installation

Troubleshooting

Configuration

Calibration

Specification

Warranty and Support

1.  Quick Guide

Reading time: 10 minutesFinish this part so you can understand and put the sensor in operation with the default configuration from the factory.

1.1 What is the Sigfox-Ready Ultrasonic Level Sensor for Trash bin and its principle of operation?

WSSFC-ULA is a Sigfox-Ready sensor with an integrated ultrasonic level sensor that can measure the waste level in the trash bin. It can be installed in the trash bin with heights from 45 cm to 450 cm.

It is battery-operated and able to connect to any Sigfox network in the World. It supports all frequency zones such as RC1, RC2, RC3c, RC4, RC5, RC6, and RC7.

For the principle operation of the ULA Ultrasonic level sensor, please refer to this link.

1.1.1 What are the typical applications of this sensor?

Please refer to this link for typical applications.

1.1.2 When does the device send uplink messages?

The device will send uplink messages in the following cases:

Case 1: After power-up in the 60s, the device will send the first message called START_UP. The payload will tell the user the HW version, FW version, and current configuration of the device;

Case 2: Then, in every interval time (pre-configured), for example, 30 minutes, it will send the message called CYCLIC_DATA. The payload will tell the user the following data like measured value (Distance and Level), battery level, alarm status...

To change the cycle of data sending, you can change the value of the parameter: CYCLIC_DATA_PERIOD (default is 1800 seconds).

Case 3: If the Alarm function was enabled (in the configuration of the sensor), if the measured value passed the threshold, it will send the uplink message immediately. This message is called ALARM. The payload also tells the user the data like measured value (distance and level), battery level, alarm status...

The alarm thresholds can be changed via downlink or offline tools.

Case 4: The HEART_BEAT uplink message will be sent once a day (the default setting can be changed in configuration) to allow the Sigfox back-end system can send the downlink message for changing the configuration of the sensor. Please refer to the downlink section for more details. The uplink payload will tell the user the HW version, FW version, and current configuration of the device;

Case 5: During commissioning, testing, or calibration sensor, the user can force the device to send the uplink message to get the data immediately. This message is called FORCE_DATA. The payload will provide data like distance from the sensor to waste, waste level, battery level, alarm status... It can be forced by applying the magnet key on the reed switch in 1s;

Case 6: If users want to change the configuration immediately, they don't need to wait up to 1 day for the HEART_BEAT message; instead they can force the device to send a special uplink message so that the device can get the new downlink message. This uplink message is named PARAMETERS_UPDATE. It can be forced by applying the magnet key in more than 5s.

1.1.3 The important configuration parameters

The sensor was pre-configured at the factory with default values for configuration parameters that meet the most use cases. However, depending on the specific use case, the customer can adjust those parameters. Please refer to section 3.2 for more details.

1.1.4 What kind of battery is used for this sensor?

The sensor is powered by 2 x AA 1.5V batteries for many years of operation. We recommend using Energizer L91 battery which is very popular and high performance. This battery has a capacity of up to 3500mAh with a working temperature range from -40 to +60 oC. The instruction for installing the batteries is in this link.

For Battery life estimation, please refer to this link.

1.2 What's in the package?

The package includes:01 x Main device01 x Magnet key01 x set of stainless steel bolts and nuts

1.3 Quick Test

With the default configuration, the device can quickly connect to the Sigfox Network by the following steps.

Step 1: Prepare the values of communication settings:

Device ID

Get Devive ID on the device nameplate

Device PAC

Get Devive PAC on the device nameplate

Note: All Sigfox sensors are pre-configured with the correct RC before delivery. The settings of Device ID, Device PAC, and RC could also be read from the device memory map. Please reference section 3.2 Sensor configuration for details.

Step 2: Add the device to Sigfox Backend

Please refer to this link for details

Step 3: Install the batteries to the device

Please refer to this link for instructions on battery installation.

After installing the battery in 60 seconds, the first data packet will be sent to the Sigfox network. After receiving the first data packet, the time of another packet depends on the value of the parameter: CYCLIC_DATA_PERIOD. Additionally, you can use a Magnet Key to force the device to send data instantly.

Step 4: Decode the payload of receiving package

Please refer to section 1.4 Uplink Payload and Data Decoding for details of decoding the receiving packet to get the measured values.

1.4 Uplink Payload and Data Decoding

For the Uplink Payload structure, please refer to this link.

Note: Please select the right Payload document to suit the FW version of the sensor

1.5 Sensor Installation

SAFETY ATTENTION:- ONLY REPLACE BATTERIES IN THE SAFE AREA WHERE THERE ARE NO FLAMMABLE GAS OR VAPOR

DIMENSIONS OF PRODUCT

1.5.1 Battery insertion

Please refer to this link for instructions.

1.5.2 Mounting sensor in trash bin

Locate the place to mount the sensor:

The sensor must be mounted on the top of the trash bin;

The sensor surface must be facing down to the bottom of the trash bin;

Notes: * The sensor must not be installed in a complete metallic trash bin as the RF signal cannot pass thru the metallic wall;* The sensor can be mounted on the movable lid. The lid will be closed all the time, it will be opened in a short time;

Please refer below to some examples of the installation.

MOUNTING SENSOR ON THE FIXED TOP WALL OF TRASH BIN

MOUNTING SENSOR ON THE MOVABLE LID OF TRASH BIN

MOUNTING SENSOR ON THE MOVABLE LID OF TRASH BIN

MOUNTING SENSOR ON THE OPEN-STYLE TRASH BIN

To get a strong RF signal, please refer to this link.

1.5.3 Sensor calibration

The Sigfox-Ready Ultrasonic level sensor is produced with accuracy as published in the specification of the product and is ready to use. However, the user may need to configure the A & B factor to give the output as the actual level of waste in the trash bin. The A & B factor will be calculated as the instructions in this link.

2. Maintenance

2.1 Troubleshooting

Problems with Sigfox communication like not receiving the packets...please refer to this link to troubleshoot the device.

Problems with the sensor functions like not measuring or inaccurate measuring....please refer to this link to troubleshoot the sensor part.

2.2 Sensor maintenance

Maintenance works

Yes/No

Descriptions

Consumable parts replacement

No

The Sigfox-Ready Ultrasonic level sensor has no consumable parts, so there is no need to replace any parts.

Cleaning sensor or device

Yes

As the sensor is installed in the trash bin, it is needed to clean the device and the transducer surface by cleaning water with a soft detergent. Please do not use strong detergent or chemical solvents to clean as they can damage the transducer surface.

Re-calibration / Re-validation

Yes

The transducer may need to be re-calibrated when necessary. Please refer to this link for the procedure of calibration.

3. Advanced Guide

3.1 Operating principle of the Sigfox-Ready Ultrasonic level sensor

3.1.1 Operating principle of the complete device

The Daviteq Sigfox-Ready Ultrasonic level sensor comprises 02 parts connected together:

- The Daviteq Sigfox-Ready wireless transmitter;- The Daviteq Ultrasonic level transducer;

The Ultrasonic level transducer measures the average distance from the sensor surface to the waste surface in the trash bin.

The Sigfox-Ready wireless transmitter is to read the distance value from the transducer and perform the scaling (A and B values, during calibration). The scaled value will indicate the level of % level of waste in the trash bin.

Level = A x Distance + BWhere:

A: Constant A

B: Constant B

Note: the minimum distance that the transducer can detect is 3cm, it is called the blind zone of the sensor.

3.1.2 Operating principle of Ultrasonic level sensor ULA

To understand how the ULA ultrasonic level sensor can measure the distance from the sensor to the object, please refer to this link for a complete understanding of this measuring technique.

3.1.3 Some important configuration parameters

Below are some important configuration parameters which affect the operation of the device like battery life, measurement accuracy, and alert threshold.

For Battery life estimation, please refer to this link.

measure_period | Default =1800sThis is the time period for the wireless transmitter to wake up and take the measurement from the transducer. The default value is 1800s. Users can reduce this value, but smaller value, shorter battery life!

cyclic_data_period | Default = 1800sInterval time to send an uplink message regardless of any conditions

sensor_boot_time | Default = 500mSThis value will affect the measurement accuracy. DO NOT change this value!

num_of_sample | Default = 30The higher value, the more filtering. This filtering can eliminate the errors caused by the un-uniformed surface of the waste and/or the moving of the lid. This value will affect the measurement accuracy. DO NOT change this value!

Those configuration parameters can be changed by downlink or offline tools. For more other configuration parameters, please refer to the next section.

3.2 Sensor Configuration

3.2.1 How to configure the Sigfox-Ready Ultrasonic level sensor?

Sensor configuration can be configured in 02 methods:

Method 1: Configuring via Downlink message. Please find the instructions in this link, but please take note of the FW version of the Document.

Method 2: Configuring via offline cable.

Note: THE SENSOR IS ONLY ACTIVE FOR OFFLINE CONFIGURATION IN THE FIRST 60 SECONDS SINCE POWER UP BY BATTERY OR PLUGGING THE CONFIGURATION CABLE.

3.2.2 What parameters of the device are configured?

Some parameters are read-only, and some are read and writeable.

To read the parameters, use the off-line cable as above instruction.

Via uplink message, users can read only one parameter, which is the CURRENT_CONFIGURATION.

Below tables are the lists of the parameters of the device.

Read-only Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

No. of Registers

Description

Range

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Read/Write Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

Check the Payload Document section: 5. Payload for downlink message for more information

274

112

3

16

1

SERVER_CONFIG

uint16

Read/Write

0: Send to Sigfox Network

1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1-4

4

uint16

Read/Write

RC zones selection 1, 2 , 3, 4 is RC1, RC2, RC3s, RC4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

0

float

Read/Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1E+09

float

Read/Write

High cut value for the calculated value

284

11C

3

16

2

LOW_CUT

0,5

float

Read/Write

Low cut value for the calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

500

uint32

Read/Write

Boot time of sensor/input, in ms

306

132

3

16

1

NUM_OF_SAMPLE

30

uint16

Read/Write

A number of samples for filtering function. The higher value, the more filtering

3.3 Calibration for Sigfox-Ready Ultrasonic Level Sensor

Please refer to this link.

4. Product specification

Please refer to the detailed specifications in this link.

5. Warranty and Support

For warranty terms and support procedures, please refer to this link.

6. References

Use-cases:

Case studies:

White-papers:

END.

Manual for Sigfox Sensors - Type 2

Sigfox Sensors - Type 2 are Tilt sensor, Soil moisture, Humidity... the sensor with Blue box housing.

Manual for Sigfox-Ready AC Current Sensor - WSSFC-AC | FW1



THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Thank you very much for choosing Daviteq Wireless Sensors. We are the leading wireless sensor manufacturer in the World. We have a wide range of wireless sensors which support different connectivity like LoRaWAN, Sigfox, Sub-GHz, NB-IoT...Please find out more information at this link.

This manual is applied to the following products

Item code

HW Version

Firmware Version

Remarks

WSSFC-AC-11

1.0

1.0

Information Changes in this version v.s previous version

Item

Changes

Changed by

Changed Date

Approved by

Approved Date

1

Initial version

D.Q.Tuan

09-04-2022

N.V.Loc

28-06-2022

To use this product, please refer step by step to the below instructions.

Operating Principle

Uplink Payload

Battery

Connect to Sigfox Network

Installation

Troubleshooting

Configuration

Calibration

Specification

Warranty and Support

1.  Quick Guide

Reading time: 10 minutesFinish this part so you can understand and put the sensor in operation with the default configuration from the factory.

1.1 What is the Sigfox-Ready AC Current Sensor and its principle of operation?

WSSFC-AC is a Sigfox-Ready sensor with an integrated AC current measuring transducer that can measure the AC current from a current transformer with max 5A AC current. It is compatible with any brand of current transformer (CT) on the market which gives an output max of 5A AC. The CT ratio will be selected based on the load current.

It is battery-operated and able to connect to any Sigfox network in the World. It supports all frequency zones such as RC1, RC2, RC3c, RC4, RC5, RC6, and RC7.

For the principle operation of the AC current sensor, please refer to this link.

1.1.1 What are the typical applications of this sensor?

Please refer to this link for typical applications.

1.1.2 When does the device send uplink messages?

The device will send uplink messages in the following cases:

Case 1: After power-up in the 60s, the device will send the first message called START_UP. The payload will tell the user the HW version, FW version, and current configuration of the device;

Case 2: Then, in every interval time (pre-configured), for example, 10 minutes, it will send the message called CYCLIC_DATA. The payload will tell the user the following data like measured value (AC current value), battery level, alarm status...

To change the cycle of data sending, you can change the value of the parameter: CYCLIC_DATA_PERIOD (default is 600 seconds).

Case 3: In case the Alarm function was enabled (in the configuration of the sensor), if the measured value passed the threshold, it will send the uplink message immediately. This message is called ALARM. The payload also tells the user the data like measured value (AC current value), battery level, alarm status...

The alarm thresholds can be changed via downlink or offline tools.

Case 4: The HEART_BEAT uplink message will be sent once a day (the default setting, can be changed in configuration) to allow the Sigfox back-end system can send the downlink message for changing the configuration of the sensor. Please refer to the downlink section for more details. The uplink payload will tell the user the HW version, FW version, and current configuration of the device;

Case 5: During commissioning, testing, or calibration sensor, the user can force the device to send the uplink message so that they can get the data immediately. This message is called FORCE_DATA. The payload will provide data like raw measured value, scaled measured value, battery level, alarm status... It can be forced by applying the magnet key on the reed switch in 1s;

Case 6: In case users want to change the configuration immediately, they don't need to wait up to 1 day for the HEART_BEAT message, instead they can force the device to send a special uplink message so that the device can get the new downlink message. This uplink message is named PARAMETERS_UPDATE. It can be forced by applying the magnet key in more than 5s.

1.1.3 The important configuration parameters

The sensor was pre-configured at the factory with default values for configuration parameters that meet the most use cases. However, depending on the specific use case, the customer can adjust those parameters. Please refer to section 3.2 for more details.

1.1.4 What kind of battery is used for this sensor?

The sensor is powered by 2 x AA 1.5V batteries for many years of operation. We do recommend using Energizer L91 battery which is very popular and high performance. This battery has a capacity of up to 3500mAh with a working temperature range from -40 to +60 oC. The instruction for installing the batteries is in this link.

For Battery life estimation, please refer to this link.

1.2 What's in the package?

The package includes:01 x Main device01 x AC current measuring transducer M12 and cable01 x Magnet key01 x Wall mounting bracket and screws

1.3 Quick Test

With the default configuration, the device can be connected quickly to the Sigfox Network by the following steps.

Step 1: Prepare the values of communication settings:

Device ID

Get Devive ID on the device nameplate

Device PAC

Get Devive PAC on the device nameplate

Note: All Sigfox sensors are pre-configured with the correct RC before delivery. The settings of Device ID, Device PAC, and RC could be also read from the device memory map. Please reference section 3.2 Sensor configuration for details.

Step 2: Add the device to Sigfox Backend

Please refer to this link for details

Step 3: Install the batteries to the device

Please refer to this link for instructions on battery installation.

After installing the battery in 60 seconds, the first data packet will be sent to the Sigfox network. After receiving the first data packet, the time of another packet depends on the value of the parameter: CYCLIC_DATA_PERIOD. Additionally, you can use a Magnet Key to force the device to send data instantly.

Step 4: Decode the payload of receiving package

Please refer to section 1.4 Uplink Payload and Data Decoding for details of decoding the receiving packet to get the measured values.

1.4 Uplink Payload and Data Decoding

For the Uplink Payload structure, please refer to this link.

Note: Please select the right Payload document to suit the FW version of the sensor

1.5 Sensor Installation

SAFETY ATTENTION:- TO REPLACE BATTERIES OR SERVICE THE MAIN DEVICE, PLEASE PAY ATTENTION TO THE ELECTRICAL SHOCK THAT MAY HAPPEN DUE TO THE PROBLEM OF THE AC CURRENT CABLE OR FAILURE OF THE CURRENT TRANSFORMER. FOR SAFETY REASONS, REMOVE THE AC CURRENT TRANSDUCER OUT OF THE MAIN DEVICE BY UN-SCREWING THE M12 CONNECTOR BEFORE OPENING THE PLASTIC HOUSING OF THE MAIN DEVICE;- ONLY QUALIFIED ELECTRICAL TECHNICIANS CAN HANDLE THIS DEVICE FOR INSTALLATION, MAINTENANCE, AND OPERATION;- USE THE HEAT-SHRINK PVC TUBE TO PROTECT THE CONNECTIONS ON THE CABLE OF THE AC CURRENT AND AVOID THE WATER CONTACT WITH THOSE ELECTRICAL CONNECTIONS.

DIMENSIONS OF PRODUCT

The Sigfox-Ready AC current sensor is a combination of a wireless transmitter and an AC current transducer. Therefore, the installation will be divided into 02 parts:

Installation for the wireless transmitter: these steps are to make sure the device sends data successfully;

Installation for AC current circuit: these steps are to make sure the device to measure correctly.

Please follow the orders of steps strictly as below.

1.5.1 Preparation of the locations

Locate the place to mount the CT, the place that is to measure the load current;

Locate the place to mount the Wireless transmitter to get the best RF signal. As the AC current transducer will be attached to the wireless transmitter, please make sure the cable length is enough for the distance from CT to the wireless transmitter;

To get a strong RF signal please refer to this link.

1.5.2 Wireless Transmitter Installation

Mount the wireless transmitter on the wall or outside the wall of the electrical panel. The antenna part must be higher than the highest point of the electrical panel. Then connect the grounding wire from the base of the wireless transmitter (if available) to the grounding system of the facility. Please check this link for the mounting guide;

Insert the batteries into the wireless transmitter and check the system to see whether the wireless transmitter already sent the first message to the system? Please follow this link to know how to install the batteries.

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

1.5.3 CT Installation

Shut down the main load before installing the CT

For closed-type CT, please shut down the main load before installing the CT.

For clamp-type CT, it is possible to install the CT onto the load wire, however, we highly recommend shutting down the main load for safety reasons.

Danger: be aware of electrical shock with AC voltage!

1.5.4 Connect the CT with the AC current transducer

Use the crimping tool to make the connection and protect the connection with a PVC heat shrink tube as this link.

1.5.5 Connect the AC transducer to Wireless Transmitter

Connect the AC transducer to the wireless transmitter via the M12 connector as this link.

1.5.6 Device calibration

The Sigfox-Ready AC current transducer is produced with accuracy as published in the specification of the product and is ready to use. However, the user can re-calibrate the sensor again when necessary, please follow the steps in this link.

1.5.7 Turn on the Main load again

After connecting, the sensor will send the data to the system with the value = zero (no AC current). Then you can turn ON the main load again to put the system into the operation.

You can use a clamp-type ampere meter to validate the value reading from the system. Please make sure the two comparison values must be collected at the same time.

2. Maintenance

2.1 Troubleshooting

Problems with Sigfox communication like not receiving the packets...please refer to this link to troubleshoot the device.

Problems with the sensor functions like not measuring, or inaccurate measuring....please refer to this link to troubleshoot the sensor part.

2.2 Sensor maintenance

Maintenance works

Yes/No

Descriptions

Consumable parts replacement

No

The Sigfox-Ready AC current sensor has no consumable part, so there is no need to replace any parts.

Cleaning sensor or device

No

Re-calibration / Re-validation

Yes

The transducer may need to be re-calibrated when necessary. Please refer to this link for the procedure of calibration.

3. Advanced Guide

3.1 Operating principle of the Sigfox-Ready AC current sensor

3.1.1 Operating principle of the complete device

The Daviteq Sigfox-Ready AC current sensor comprises 02 parts connected together as shown below picture.

- The Daviteq Sigfox-Ready wireless transmitter;- The Daviteq AC 5A current Transducer;

The AC current transducer is to measure the actual AC current of the secondary winding of the CT.

The Sigfox-Ready is to read the AC current value from the transducer and perform the scaling (A and B values, during calibration). The scaled current will be multiplied by the CT ratio to deliver the final value which is the actual load current that the user wants to measure.

Scaled_CT_Current = A x CT_Current + B

Actual_Load_Current = Scaled_CT_Current x CT

Where:

A : Constant A

B : Constant B

CT_current: the measured current from the transducer (Secondary winding current of the CT)

For example: the CT_current = 1.5A, the CT ratio = 20 (the CT is 100/5), A=1, B=0 ==> then the Actual_Load_Current = 1.5 x 20 = 30A

Note: the Low cut value of Actual_Load_Current is 0.5A. That meant the device can not measure the current load less than 0.5A

3.1.2 Operating principle of AC current transducer

To understand how the AC current transducer can measure AC current, please refer to this link for a complete understanding of this measuring technique.

3.1.3 Some important configuration parameters

Below are some important configuration parameters which affect the operation of the device like battery life, measurement accuracy, and alert threshold.

For Battery life estimation, please refer to this link.

measure_period | Default = 600sThis is the time period for the wireless transmitter to wake up and take the measurement from the transducer. The default value is 600s. Users can reduce this value, but smaller value, shorter battery life!

cyclic_data_period | Default = 600sInterval time to send an uplink message regardless of any conditions

sensor_boot_time | Default = 1000mSThis value will affect the measurement accuracy. DO NOT change this value!

Those configuration parameters can be changed by downlink or offline tools. For more other configuration parameters, please refer to the next section.

3.2 Sensor Configuration

3.2.1 How to configure the Sigfox-Ready AC Current Sensor?

Sensor configuration can be configured in 02 methods:

Method 1: Configuring via Downlink message. Please find the instructions in this link, but please take note of the FW version of the Document.

Method 2: Configuring via offline cable.

Note: THE SENSOR IS ONLY ACTIVE FOR OFFLINE CONFIGURATION IN THE FIRST 60 SINCE POWER UP BY BATTERY OR PLUGGING THE CONFIGURATION CABLE.

3.2.2 What parameters of the device are configured?

Some parameters are read-only, and some are read and writeable.

To read the parameters, use the off-line cable as above instruction.

Via uplink message, users can read only one parameter, which is the CURRENT_CONFIGURATION.

Below tables are the lists of the parameters of the device.

Read-only Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

No. of Registers

Description

Range

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Read/Write Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

Check the Payload Document section: 5.Payload for downlink message for more information

274

112

3

16

1

SERVER_CONFIG

uint16

Read/Write

0: Send to Sigfox Network

1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1-4

4

uint16

Read/Write

RC zones selection 1, 2 , 3, 4 is RC1, RC2, RC3s, RC4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

0

float

Read/Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1E+09

float

Read/Write

High cut value for the calculated value

284

11C

3

16

2

LOW_CUT

0,5

float

Read/Write

Low cut value for the calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

1000

uint32

Read/Write

Boot time of sensor/input, in ms

306

132

3

16

2

CT

40

float

Read/Write

CT of current transformer

3.3 Calibration for Sigfox-Ready AC current transducer

Please refer to this link.

4. Product specification

Please refer to the detailed specifications in this link.

5. Warranty and Support

For warranty terms and support procedures, please refer to this link.

6. References

Use-cases:

Case studies:

White-papers:

END.

Manual for Sigfox-Ready Air/Gas Flow Sensor - WSSFC-M12F-AFD | FW1



THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Thank you very much for choosing Daviteq Wireless Sensors. We are the leading wireless sensor manufacturer in the World. We have a wide range of wireless sensors which support different connectivity like LoRaWAN, Sigfox, Sub-GHz, NB-IoT...Please find out more information at this link.

This manual is applied to the following products

Item code

HW Version

Firmware Version

Remarks

WSSFC-M12F-AFD

1

Product Features

Connectivity Type

Sigfox

Product Type

2 parts

Mounting Type

Direct process mounting for the whole set

Powered by

2 x AA batteries 1.5V

Information Changes in this version v.s previous version

Item

Changes

Changed by

Changed Date

Approved by

Approved Date

1

Initial version

D.Q.Tuan

26-08-2022

N.V.Loc

05-09-2022

To use this product, please refer step by step to the below instructions.

Operating Principle

Uplink Payload

Battery

Connect to Sigfox Network

Installation

Troubleshooting

Configuration

Calibration

Specification

Warranty and Support

1.  Quick Guide

Reading time: 10 minutesFinish this part so you can understand and put the sensor in operation with the default configuration from the factory.

1.1 What is the Sigfox-Ready AFD Air/Gas Flow Sensor and its principle of operation?

WSSFC-M12F-AFD is a Sigfox-Ready node to work with an AFD probe for measuring the Air/Gas Flow in a pipe or duct.

It is battery-operated and able to connect to any Sigfox network in the World. It supports all frequency zones such as RC1, RC2, RC3c, RC4, RC5, RC6, and RC7.

For the principle operation of the AFD probe, please refer to this link.

1.1.1 What are the typical applications of this sensor?

Please refer to this link for typical applications.

1.1.2 When does the device send uplink messages?

The device will send uplink messages in the following cases:

Case 1: After power-up in the 60s, the device will send the first message called START_UP. The payload will tell the user the HW version, FW version, and current configuration of the device;

Case 2: Then, in every interval time (pre-configured), for example, 10 minutes, it will send the message called CYCLIC_DATA. The payload will tell the user the following data like measured value (AC current value), battery level, alarm status...

To change the cycle of data sending, you can change the value of the parameter: CYCLIC_DATA_PERIOD (default is 600 seconds).

Case 3: If the Alarm function was enabled (in the configuration of the sensor), if the measured value passed the threshold, it will send the uplink message immediately. This message is called ALARM. The payload also tells the user the data like measured value (AC current value), battery level, alarm status...

The alarm thresholds can be changed via downlink or offline tools.

Case 4: The HEART_BEAT uplink message will be sent once a day (the default setting can be changed in configuration) to allow the Sigfox back-end system can send the downlink message for changing the configuration of the sensor. Please refer to the downlink section for more details. The uplink payload will tell the user the HW version, FW version, and current configuration of the device;

Case 5: During commissioning, testing, or calibration sensor, the user can force the device to send the uplink message to get the data immediately. This message is called FORCE_DATA. The payload will provide data like raw measured value, scaled measured value, battery level, alarm status... It can be forced by applying the magnet key on the reed switch in 1s;

Case 6: If users want to change the configuration immediately, they don't need to wait up to 1 day for the HEART_BEAT message, instead they can force the device to send a special uplink message so that the device can get the new downlink message. This uplink message is named PARAMETERS_UPDATE. It can be forced by applying the magnet key in more than 5s.

1.1.3 The important configuration parameters

The sensor was pre-configured at the factory with default values for configuration parameters that meet most use cases. However, depending on the specific use case, the customer can adjust those parameters. Please refer to section 3.2 for more details.

1.1.4 What kind of battery is used for this sensor?

The sensor is powered by 2 x AA 1.5V batteries for many years of operation. We do recommend using Energizer L91 battery which is very popular and high performance. This battery has a capacity of up to 3500mAh with a working temperature range from -40 to +60 oC. The instruction for installing the batteries is in this link.

Figure 1. Battery Energizer L91

For Battery life estimation, please refer to this link.

1.2 What's in the package?

The package includes:01 x Main device01 x Magnet key01 x Wall mounting bracket and screws01 x AFD flow sensor probe (order separately with item code AFD-....)

Figure 2. Product package of WSSFC-M12F-AFD

Figure 3. Product package of AFD-....

1.3 Quick Test

With the default configuration, the device can be connected quickly to the Sigfox Network by the following steps.

Step 1: Prepare the values of communication settings:

Device ID

Get Devive ID on the device nameplate

Device PAC

Get Devive PAC on the device nameplate

Note: All Sigfox sensors are pre-configured with the correct RC before delivery. The settings of Device ID, Device PAC, and RC could also be read from the device memory map. Please reference section 3.2 Sensor configuration for details.

Step 2: Add the device to Sigfox Backend

Please refer to this link for details

Step 3: Install the batteries to the device

Please refer to this link for instructions on battery installation.

After installing the battery in 60 seconds, the first data packet will be sent to the Sigfox network. After receiving the first data packet, the time of another packet depends on the value of the parameter: CYCLIC_DATA_PERIOD. Additionally, you can use a Magnet Key to force the device to send data instantly.

Step 4: Decode the payload of receiving package

Please refer to section 1.4 Uplink Payload and Data Decoding for details of decoding the receiving packet to get the measured values.

1.4 Uplink Payload and Data Decoding

For the Uplink Payload structure, please refer to this link.

Note: Please select the right Payload document to suit the FW version of the sensor

1.5 Sensor Installation

DIMENSIONS OF PRODUCT

Figure 4. Dimensions of WSSFC-M12F-AFD

Figure 5. Dimensions of AFD-0200

1.5.1 Installation

The Sigfox-Ready AFD Air/Gas flow sensor combines a wireless transmitter WSSFC-M12F-AFD and an AFD Air/Gas Flow Sensor. Therefore, the installation will be divided into 02 parts:

+ Installation for AFD Air/Gas Flow Sensor: these steps are to make sure the device to measure correctly. Please follow this link.

+ Installation for the wireless transmitter: these steps ensure the device sends data successfully. Please see below the steps

Insert the batteries into the wireless transmitter and check the system to see whether the wireless transmitter already sent the first message to the system. Please follow this link to learn how to install the batteries.

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Attach the wireless transmitter to the AFD probe as below figures.

Figure 6. Complete set of WSSFC-M12F-AFD and AFD-0200

1.5.2 Device calibration & configuration

Please refer to this link.

2. Maintenance

2.1 Troubleshooting

Problems with Sigfox communication like not receiving the packets...please refer to this link to troubleshoot the device.

Problems with the sensor functions like not measuring or inaccurate measuring....please refer to this link to troubleshoot the sensor part.

2.2 Device maintenance

2.2.1 Maintenance for Wireless transmitter WSSFC-M12F-AFD

Maintenance works

Yes/No

Descriptions

Consumable parts replacement

Yes

The battery is the only part need to check the lifetime to replace. Check the battery status on the back-end system.

Cleaning device

No

Re-calibration / Re-validation

No

No calibration is required for the wireless transmitter.

2.2.2 Maintenance for AFD flow probe

Please refer to this link.

3. Advanced Guide

3.1 Operating principle of the Sigfox-Ready AFD Air/Gas Flow Sensor

3.1.1 Operating principle of the complete device

The Daviteq Sigfox-Ready AFD Air/Gas Flow sensor comprises 02 parts connected together as shown below picture.

- The Daviteq Sigfox-Ready wireless transmitter WSSFC-M12F-AFD- The Daviteq AFD Air/Gas Flow Sensor AFD-...

Figure 7. Complete set of WSSFC-M12F-AFD and AFD-0200

The AFD Air/Gas Flow Sensor measures pressure and temperature... in the duct or pipe.

The Sigfox-Ready wireless transmitter is to read the parameters of the probe like differential pressure, temperature, and error code... and performs the scaling and calculation to deliver the fluid velocity in the duct or pipe.

3.1.2 Operating principle of AFD Air/Gas Flow Sensor

To understand how the AFD Air/Gas Flow Sensor works, please refer to this link for a complete understanding of this measuring technique.

3.1.3 Some important configuration parameters

Below are some important configuration parameters which affect the operation of the device like battery life, measurement accuracy, and alert threshold.

For Battery life estimation, please refer to this link.

measure_period | Default = 600sThis is the time period for the wireless transmitter to wake up and take the measurement from the transducer. The default value is 600s. Users can reduce this value, but smaller value, shorter battery life!

cyclic_data_period | Default = 1800sInterval time to send an uplink message regardless of any conditions

sensor_boot_time | Default = 200mSThis value will affect the measurement accuracy. DO NOT change this value!

density_of_fluid | Default = 1.225 (Air)This value will affect the measurement accuracy.

Those configuration parameters can be changed by downlink or offline tools. For more other configuration parameters, please refer to the next section.

3.2 Sensor Configuration

3.2.1 How to configure the Sigfox-Ready AFD Air/Gas Flow Sensor?

Sensor configuration can be configured in 02 methods:

Method 1: Configuring via Downlink message. Please find the instructions in this link, but please take note of the FW version of the Document.

Method 2: Configuring via offline cable.

Note: THE SENSOR IS ONLY ACTIVE FOR OFFLINE CONFIGURATION IN THE FIRST 60 SINCE POWER UP BY BATTERY OR PLUGGING THE CONFIGURATION CABLE.

3.2.2 What parameters of the device are configured?

Some parameters are read-only, and some are read and writeable.

To read the parameters, use the off-line cable as above instruction.

Via uplink message, users can read only one parameter, which is the CURRENT_CONFIGURATION.

Below tables are the lists of the parameters of the device.

Read-only Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

No. of Registers

Description

Range

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Read/Write Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

Check the Payload Document section: 5.Payload for downlink message for more information

274

112

3

16

1

SERVER_CONFIG

0

uint16

Read/Write

0: Send to Sigfox Network

1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1-4

4

uint16

Read/Write

RC zones selection 1, 2 , 3, 4 is RC1, RC2, RC3s, RC4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

0

float

Read/Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1E+09

float

Read/Write

High cut value for the calculated value

284

11C

3

16

2

LOW_CUT

0

float

Read/Write

Low cut value for the calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

200

uint32

Read/Write

Boot time of sensor/input, in ms

307

133

3

16

1

TEMPERATURE_OFFSET_X10

0

int16

Read/Write

Offset adjustment for measured temperature value

308

134

3

16

2

DENSITY_OF_FLUID

1.225

float

Read/Write

Fluid Density, default is Air

3.3 Calibration for Sigfox-Ready AFD Air/Gas Flow Sensor

Please refer to this link.

4. Product specification

Please refer to the detailed specifications in this link.

5. Warranty and Support

For warranty terms and support procedures, please refer to this link.

6. References

Use-cases:

Case studies:

White-papers:

END.

Manual for Sigfox-Ready Single-Axis Vibration Sensor - WSSFC-V1A | FW2



THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Thank you very much for choosing Daviteq Wireless Sensors. We are the leading wireless sensor manufacturer in the World. We have a wide range of wireless sensors which support different connectivity like LoRaWAN, Sigfox, Sub-GHz, NB-IoT...Please find out more information at this link.

This manual is applied to the following products

Item code

HW Version

Firmware Version

Remarks

WSSFC-V1A-025

2

Product Features

Connectivity Type

Sigfox

Product Type

2 parts

Mounting Type

Direct process mounting for sensor, wall mount for transmitter

Powered by

2 x AA batteries 1.5V

Information Changes in this version v.s previous version

Item

Changes

Changed by

Changed Date

Approved by

Approved Date

1

Initial version

D.Q.Tuan

29-08-2022

N.V.Loc

05-09-2022

To use this product, please refer step by step to the below instructions.

Operating Principle

Uplink Payload

Battery

Connect to Sigfox Network

Installation

Troubleshooting

Configuration

Calibration

Specification

Warranty and Support

1.  Quick Guide

Reading time: 10 minutesFinish this part so you can understand and put the sensor in operation with the default configuration from the factory.

1.1 What is the Sigfox-Ready V1A Single-Axis Vibration Sensor and its principle of operation?

WSSFC-V1A is a cost-effective, single-axis vibration sensor designed for condition monitoring and preventive maintenance applications. The piezo-electric accelerometer is available in ranges ±25g or 50g and features a flat frequency response up to >10kHz. Its accelerometer feature a stable piezo-ceramic crystal in shear mode with low-power electronics, sealed in a fully hermetic package. The Piezo Electric technology incorporated in the WSSCF-V1A accelerometer has a proven track record for offering the reliable and long-term stable output required for condition monitoring applications. The accelerometer is designed and qualified for machine health monitoring and has superior Resolution, Dynamic Range, and Bandwidth to MEMS devices. Besides that, it can also measure the temperature at the mounting point.

It is battery-operated and able to connect to any Sigfox network in the World. It supports all frequency zones such as RC1, RC2, RC3c, RC4, RC5, RC6, and RC7.

For the principle operation of the V1A single-axis vibration sensor, please refer to this link.

1.1.1 What are the typical applications of this sensor?

Please refer to this link for typical applications.

1.1.2 When does the device send uplink messages?

The device will send uplink messages in the following cases:

Case 1: After power-up in the 60s, the device will send the first message called START_UP. The payload will tell the user the HW version, FW version, and current configuration of the device;

Case 2: Then, in every interval time (pre-configured), for example, 10 minutes, it will send the message called CYCLIC_DATA. The payload will tell the user the following data like measured values, battery level, alarm status...

To change the cycle of data sending, you can change the value of the parameter: CYCLIC_DATA_PERIOD (default is 600 seconds).

Case 3: If the Alarm function was enabled (in the configuration of the sensor), if the measured value passed the threshold, it will send the uplink message immediately. This message is called ALARM. The payload also tells the user the data like measured values, battery level, alarm status...

The alarm thresholds can be changed via downlink or offline tools.

Case 4: The HEART_BEAT uplink message will be sent once a day (the default setting can be changed in configuration) to allow the Sigfox back-end system can send the downlink message for changing the configuration of the sensor. Please refer to the downlink section for more details. The uplink payload will tell the user the HW version, FW version, and current configuration of the device;

Case 5: During commissioning, testing, or calibration sensor, the user can force the device to send the uplink message to get the data immediately. This message is called FORCE_DATA. The payload will provide data like raw measured value, scaled measured value, battery level, alarm status... It can be forced by applying the magnet key on the reed switch in 1s;

Case 6: If users want to change the configuration immediately, they don't need to wait up to 1 day for the HEART_BEAT message, instead they can force the device to send a special uplink message so that the device can get the new downlink message. This uplink message is named PARAMETERS_UPDATE. It can be forced by applying the magnet key in more than 5s.

1.1.3 The important configuration parameters

The sensor was pre-configured at the factory with default values for configuration parameters that meet most use cases. However, depending on the specific use case, the customer can adjust those parameters. Please refer to section 3.2 for more details.

1.1.4 What kind of battery is used for this sensor?

The sensor is powered by 2 x AA 1.5V batteries for many years of operation. We do recommend using Energizer L91 battery which is very popular and high performance. This battery has a capacity of up to 3500mAh with a working temperature range from -40 to +60 oC. The instruction for installing the batteries is in this link.

Figure 1. Battery Energizer L91

For Battery life estimation, please refer to this link.

1.2 What's in the package?

The package includes:01 x Main device with 2m M12 cable01 x Magnet key01 x Wall mounting bracket and screws01 x Vibration sensor module V1A

Figure 2. Product package of WSSFC-V1A-025

1.3 Quick Test

With the default configuration, the device can be connected quickly to the Sigfox Network by the following steps.

Step 1: Prepare the values of communication settings:

Device ID

Get Devive ID on the device nameplate

Device PAC

Get Devive PAC on the device nameplate

Note: All Sigfox sensors are pre-configured with the correct RC before delivery. The settings of Device ID, Device PAC, and RC could also be read from the device memory map. Please reference section 3.2 Sensor configuration for details.

Step 2: Add the device to Sigfox Backend

Please refer to this link for details

Step 3: Install the batteries to the device

Please refer to this link for instructions on battery installation.

After installing the battery in 60 seconds, the first data packet will be sent to the Sigfox network. After receiving the first data packet, the time of another packet depends on the value of the parameter: CYCLIC_DATA_PERIOD. Additionally, you can use a Magnet Key to force the device to send data instantly.

Step 4: Decode the payload of receiving package

Please refer to section 1.4 Uplink Payload and Data Decoding for details of decoding the receiving packet to get the measured values.

1.4 Uplink Payload and Data Decoding

For the Uplink Payload structure, please refer to this link.

Note: Please select the right Payload document to suit the FW version of the sensor

1.5 Sensor Installation

1.5.1 Dimension drawings

Figure 3. Dimensions of Sigfox Transmitter

Figure 4. Dimensions of V1A vibration sensor module

1.5.2 Installation

The Sigfox-Ready V1A vibration sensor combines a wireless transmitter WSSFC and a V1A vibration sensor. Therefore, the installation will be divided into 02 parts:

INSTALLATION GUIDE FOR V1A SENSOR MODULE

INSTALLATION GUIDE FOR WIRELESS TRANSMITTER.

PLEASE SEE THE BELOW STEPS.

Mount the wireless transmitter on the wall or a pole nearby the object to monitor the vibration. The wireless transmitter must be mounted at the minimum level of 2m from the ground for a better RF signal. To get the strongest RF signal, please follow this link.

How to mount it with a mounting bracket? please check this guide.

Insert the batteries into the wireless transmitter and check the system to see whether the wireless transmitter already sent the first message to the system. Please follow this link to learn how to install the batteries.

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Connect the M12 cable to the V1A sensor module as below figure.

Figure 5. Complete set of WSSFC-V1A-025 vibration sensor

1.5.3 Device calibration & configuration

Please refer to this link.

2. Maintenance

2.1 Troubleshooting

Problems with Sigfox communication like not receiving the packets...please refer to this link to troubleshoot the device.

Problems with the sensor functions like not measuring or inaccurate measuring....please refer to this link to troubleshoot the sensor part.

2.2 Device maintenance

2.2.1 Maintenance for Wireless transmitter

Maintenance works

Yes/No

Descriptions

Consumable parts replacement

Yes

The battery is the only part need to check the lifetime to replace. Check the battery status on the back-end system.

Cleaning device

No

Re-calibration / Re-validation

No

No calibration is required for the wireless transmitter.

2.2.2 Maintenance for V1A sensor module

Please refer to this link.

3. Advanced Guide

3.1 Operating principle of the Sigfox-Ready V1A Single-axis Vibration Sensor

3.1.1 Operating principle of the complete device

The Daviteq Sigfox-Ready V1A Single-axis Vibration Sensor comprises 02 parts connected together as shown below picture.

- The Daviteq Sigfox-Ready wireless transmitter- The Daviteq V1A vibration sensor module

Figure 6. Complete set of WSSFC-V1A-025 vibration sensor mounted on the motor

The V1A single-axis vibration sensor measures the vibration of the object.

The Sigfox-Ready wireless transmitter is to read the measurement values from the V1A sensor and performs the scaling and calculation to deliver accurate outputs.

3.1.2 Operating principle of V1A single-axis vibration sensor

To understand how the V1A single-axis vibration sensor works, please refer to this link for a complete understanding of this measuring technique.

3.1.3 Some important configuration parameters

Below are some important configuration parameters which affect the operation of the device like battery life, measurement accuracy, and alert threshold.

For Battery life estimation, please refer to this link.

measure_period | Default = 3600sThis is the time period for the wireless transmitter to wake up and take the measurement from the transducer. The default value is 3600s. Users can reduce this value, but smaller value, shorter battery life!

cyclic_data_period | Default = 3600sInterval time to send an uplink message regardless of any conditions

constant_A | Default = calibrated value by factoryThis value will affect the measurement accuracy. DO NOT change this value!

Those configuration parameters can be changed by downlink or offline tools. For more other configuration parameters, please refer to the next section.

3.2 Sensor Configuration

3.2.1 How to configure the Sigfox-Ready V1A Sing-axis Vibration Sensor?

Sensor configuration can be configured in 02 methods:

Method 1: Configuring via Downlink message. Please find the instructions in this link, but please take note of the FW version of the Document.

Method 2: Configuring via offline cable.

Note: THE SENSOR IS ONLY ACTIVE FOR OFFLINE CONFIGURATION IN THE FIRST 60 SINCE POWER UP BY BATTERY OR PLUGGING THE CONFIGURATION CABLE.

3.2.2 What parameters of the device are configured?

Some parameters are read-only, and some are read and writeable.

To read the parameters, use the off-line cable as above instruction.

Via uplink message, users can read only one parameter, which is the CURRENT_CONFIGURATION.

Below tables are the lists of the parameters of the device.

Read-only Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

No. of Registers

Description

Range

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Read/Write Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

Check the Payload Document section: 5.Payload for downlink message for more information

274

112

3

16

1

SERVER_CONFIG

0

uint16

Read/Write

0: Send to Sigfox Network

1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1-4

4

uint16

Read/Write

RC zones selection 1, 2 , 3, 4 is RC1, RC2, RC3s, RC4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value

306

132

3

16

1

ENB_DATGRAM

1

uint16

Read/Write

bit0: enable datagram 0bit1: enable datagram 1bit2: enable datagram 2

307

133

3

16

1

TEMPERATURE_OFFSET_X10

0

int16

Read/Write

Offset adjustment for measured temperature value

3.3 Calibration for Sigfox-Ready V1A Vibration Sensor

Please refer to this link.

4. Product specification

Please refer to the detailed specifications in this link.

5. Warranty and Support

For warranty terms and support procedures, please refer to this link.

6. References

Use-cases:

Case studies:

White-papers:

END.

Manual for Sigfox-Ready AC Current Sensor - WSSFC-AC | FW3

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Thank you very much for choosing Daviteq Wireless Sensors. We are the leading wireless sensor manufacturer in the World. We have a wide range of wireless sensors which support different connectivity like LoRaWAN, Sigfox, Sub-GHz, NB-IoT...Please find out more information at this link.

This manual is applied to the following products

Item code

HW Version

Firmware Version

Remarks

WSSFC-AC-11

2H

3F

Information Changes in this version v.s previous version

Item

Changes

Changed by

Changed Date

Approved by

Approved Date

1

Initial version

D.Q.Tuan

24-06-2023

N.V.Loc

28-06-2023

To use this product, please refer step by step to the below instructions.

Operating Principle

Uplink Payload

Battery

Connect to Sigfox Network

Installation

Troubleshooting

Configuration

Calibration

Specification

Warranty and Support

1.  Quick Guide

Reading time: 10 minutesFinish this part so you can understand and put the sensor in operation with the default configuration from the factory.

1.1 What is the Sigfox-Ready AC Current Sensor and its principle of operation?

WSSFC-AC is a Sigfox-Ready sensor with an integrated AC current measuring transducer that can measure the AC current from a current transformer with max 5A AC current. It is compatible with any brand of current transformer (CT) on the market which gives an output max of 5A AC. The CT ratio will be selected based on the load current.

It is battery-operated and able to connect to any Sigfox network in the World. It supports all frequency zones such as RC1, RC2, RC3c, RC4, RC5, RC6, and RC7.

For the principle operation of the AC current sensor, please refer to this link.

1.1.1 What are the typical applications of this sensor?

Please refer to this link for typical applications.

1.1.2 When does the device send uplink messages?

The device will send uplink messages in the following cases:

Case 1: After power-up in the 60s, the device will send the first message called START_UP. The payload will tell the user the HW version, FW version, and current configuration of the device;

Case 2: Then, in every interval time (pre-configured), for example, 10 minutes, it will send the message called CYCLIC_DATA. The payload will tell the user the following data like measured value (AC current value), battery level, alarm status...

To change the cycle of data sending, you can change the value of the parameter: CYCLIC_DATA_PERIOD (default is 600 seconds).

Case 3: In case the Alarm function was enabled (in the configuration of the sensor), if the measured value passed the threshold, it will send the uplink message immediately. This message is called ALARM. The payload also tells the user the data like measured value (AC current value), battery level, alarm status...

The alarm thresholds can be changed via downlink or offline tools.

Case 4: The HEART_BEAT uplink message will be sent once a day (the default setting, can be changed in configuration) to allow the Sigfox back-end system can send the downlink message for changing the configuration of the sensor. Please refer to the downlink section for more details. The uplink payload will tell the user the HW version, FW version, and current configuration of the device;

Case 5: During commissioning, testing, or calibration sensor, the user can force the device to send the uplink message so that they can get the data immediately. This message is called FORCE_DATA. The payload will provide data like raw measured value, scaled measured value, battery level, alarm status... It can be forced by applying the magnet key on the reed switch in 1s;

Case 6: In case users want to change the configuration immediately, they don't need to wait up to 1 day for the HEART_BEAT message, instead they can force the device to send a special uplink message so that the device can get the new downlink message. This uplink message is named PARAMETERS_UPDATE. It can be forced by applying the magnet key in more than 5s.

1.1.3 The important configuration parameters

The sensor was pre-configured at the factory with default values for configuration parameters that meet the most use cases. However, depending on the specific use case, the customer can adjust those parameters. Please refer to section 3.2 for more details.

1.1.4 What kind of battery is used for this sensor?

The sensor is powered by 2 x AA 1.5V batteries for many years of operation. We do recommend using Energizer L91 battery which is very popular and high performance. This battery has a capacity of up to 3500mAh with a working temperature range from -40 to +60 oC. The instruction for installing the batteries is in this link.

For Battery life estimation, please refer to this link.

1.2 What's in the package?

The package includes:01 x Main device01 x AC current measuring transducer M12 and cable01 x Magnet key01 x Wall mounting bracket and screws

1.3 Quick Test

With the default configuration, the device can be connected quickly to the Sigfox Network by the following steps.

Step 1: Prepare the values of communication settings:

Device ID

Get Devive ID on the device nameplate

Device PAC

Get Devive PAC on the device nameplate

Note: All Sigfox sensors are pre-configured with the correct RC before delivery. The settings of Device ID, Device PAC, and RC could be also read from the device memory map. Please reference section 3.2 Sensor configuration for details.

Step 2: Add the device to Sigfox Backend

Please refer to this link for details

Step 3: Install the batteries to the device

Please refer to this link for instructions on battery installation.

After installing the battery in 60 seconds, the first data packet will be sent to the Sigfox network. After receiving the first data packet, the time of another packet depends on the value of the parameter: CYCLIC_DATA_PERIOD. Additionally, you can use a Magnet Key to force the device to send data instantly.

Step 4: Decode the payload of receiving package

Please refer to section 1.4 Uplink Payload and Data Decoding for details of decoding the receiving packet to get the measured values.

1.4 Uplink Payload and Data Decoding

For the Uplink Payload structure, please refer to this link.

Note: Please select the right Payload document to suit the FW version of the sensor

1.5 Sensor Installation

SAFETY ATTENTION:- TO REPLACE BATTERIES OR SERVICE THE MAIN DEVICE, PLEASE PAY ATTENTION TO THE ELECTRICAL SHOCK THAT MAY HAPPEN DUE TO THE PROBLEM OF THE AC CURRENT CABLE OR FAILURE OF THE CURRENT TRANSFORMER. FOR SAFETY REASONS, REMOVE THE AC CURRENT TRANSDUCER OUT OF THE MAIN DEVICE BY UN-SCREWING THE M12 CONNECTOR BEFORE OPENING THE PLASTIC HOUSING OF THE MAIN DEVICE;- ONLY QUALIFIED ELECTRICAL TECHNICIANS CAN HANDLE THIS DEVICE FOR INSTALLATION, MAINTENANCE, AND OPERATION;- USE THE HEAT-SHRINK PVC TUBE TO PROTECT THE CONNECTIONS ON THE CABLE OF THE AC CURRENT AND AVOID THE WATER CONTACT WITH THOSE ELECTRICAL CONNECTIONS.

DIMENSIONS OF PRODUCT

The Sigfox-Ready AC current sensor is a combination of a wireless transmitter and an AC current transducer. Therefore, the installation will be divided into 02 parts:

Installation for the wireless transmitter: these steps are to make sure the device sends data successfully;

Installation for AC current circuit: these steps are to make sure the device to measure correctly.

Please follow the orders of steps strictly as below.

1.5.1 Preparation of the locations

Locate the place to mount the CT, the place that is to measure the load current;

Locate the place to mount the Wireless transmitter to get the best RF signal. As the AC current transducer will be attached to the wireless transmitter, please make sure the cable length is enough for the distance from CT to the wireless transmitter;

To get a strong RF signal please refer to this link.

1.5.2 Wireless Transmitter Installation

Mount the wireless transmitter on the wall or outside the wall of the electrical panel. The antenna part must be higher than the highest point of the electrical panel. Then connect the grounding wire from the base of the wireless transmitter (if available) to the grounding system of the facility. Please check this link for the mounting guide;

Insert the batteries into the wireless transmitter and check the system to see whether the wireless transmitter already sent the first message to the system? Please follow this link to know how to install the batteries.

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

1.5.3 CT Installation

Shut down the main load before installing the CT

For closed-type CT, please shut down the main load before installing the CT.

For clamp-type CT, it is possible to install the CT onto the load wire, however, we highly recommend shutting down the main load for safety reasons.

Danger: be aware of electrical shock with AC voltage!

1.5.4 Connect the CT with the AC current transducer

Use the crimping tool to make the connection and protect the connection with a PVC heat shrink tube as this link.

1.5.5 Connect the AC transducer to Wireless Transmitter

Connect the AC transducer to the wireless transmitter via the M12 connector as this link.

1.5.6 Device calibration

The Sigfox-Ready AC current transducer is produced with accuracy as published in the specification of the product and is ready to use. However, the user can re-calibrate the sensor again when necessary, please follow the steps in this link.

1.5.7 Turn on the Main load again

After connecting, the sensor will send the data to the system with the value = zero (no AC current). Then you can turn ON the main load again to put the system into the operation.

You can use a clamp-type ampere meter to validate the value reading from the system. Please make sure the two comparison values must be collected at the same time.

2. Maintenance

2.1 Troubleshooting

Problems with Sigfox communication like not receiving the packets...please refer to this link to troubleshoot the device.

Problems with the sensor functions like not measuring, or inaccurate measuring....please refer to this link to troubleshoot the sensor part.

2.2 Sensor maintenance

Maintenance works

Yes/No

Descriptions

Consumable parts replacement

No

The Sigfox-Ready AC current sensor has no consumable part, so there is no need to replace any parts.

Cleaning sensor or device

No

Re-calibration / Re-validation

Yes

The transducer may need to be re-calibrated when necessary. Please refer to this link for the procedure of calibration.

3. Advanced Guide

3.1 Operating principle of the Sigfox-Ready AC current sensor

3.1.1 Operating principle of the complete device

The Daviteq Sigfox-Ready AC current sensor comprises 02 parts connected together as shown below picture.

- The Daviteq Sigfox-Ready wireless transmitter;- The Daviteq AC 5A current Transducer;

The AC current transducer is to measure the actual AC current of the secondary winding of the CT.

The Sigfox-Ready is to read the AC current value from the transducer and perform the scaling (A and B values, during calibration). The scaled current will be multiplied by the CT ratio to deliver the final value which is the actual load current that the user wants to measure.

Scaled_CT_Current = A x CT_Current + B

Actual_Load_Current = Scaled_CT_Current x CT

Where:

A : Constant A

B : Constant B

CT_current: the measured current from the transducer (Secondary winding current of the CT)

For example: the CT_current = 1.5A, the CT ratio = 20 (the CT is 100/5), A=1, B=0 ==> then the Actual_Load_Current = 1.5 x 20 = 30A

Note: the Low cut value of Actual_Load_Current is 0.5A. That meant the device can not measure the current load less than 0.5A

3.1.2 Operating principle of AC current transducer

To understand how the AC current transducer can measure AC current, please refer to this link for a complete understanding of this measuring technique.

3.1.3 Some important configuration parameters

Below are some important configuration parameters which affect the operation of the device like battery life, measurement accuracy, and alert threshold.

For Battery life estimation, please refer to this link.

measure_period | Default = 600sThis is the time period for the wireless transmitter to wake up and take the measurement from the transducer. The default value is 600s. Users can reduce this value, but smaller value, shorter battery life!

cyclic_data_period | Default = 600sInterval time to send an uplink message regardless of any conditions

sensor_boot_time | Default = 1000mSThis value will affect the measurement accuracy. DO NOT change this value!

Those configuration parameters can be changed by downlink or offline tools. For more other configuration parameters, please refer to the next section.

3.2 Sensor Configuration

3.2.1 How to configure the Sigfox-Ready AC Current Sensor?

Sensor configuration can be configured in 02 methods:

Method 1: Configuring via Downlink message. Please find the instructions in this link, but please take note of the FW version of the Document.

Method 2: Configuring via offline cable.

Note: THE SENSOR IS ONLY ACTIVE FOR OFFLINE CONFIGURATION IN THE FIRST 60 SINCE POWER UP BY BATTERY OR PLUGGING THE CONFIGURATION CABLE.

3.2.2 What parameters of the device are configured?

Some parameters are read-only, and some are read and writeable.

To read the parameters, use the off-line cable as above instruction.

Via uplink message, users can read only one parameter, which is the CURRENT_CONFIGURATION.

Below tables are the lists of the parameters of the device.

Read-only Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

No. of Registers

Description

Range

Format

Property

Comment

259

103

3

9

SERIAL NUMBER

string

Read

Sensor serial number

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Read/Write Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

Check the Payload Document section: 5.Payload for downlink message for more information

274

112

3

16

1

SERVER_CONFIG

uint16

Read/Write

0: Send to Sigfox Network

1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1-4

4

uint16

Read/Write

RC zones selection 1, 2 , 3, 4 is RC1, RC2, RC3s, RC4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

0

float

Read/Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1E+09

float

Read/Write

High cut value for the calculated value

284

11C

3

16

2

LOW_CUT

0,5

float

Read/Write

Low cut value for the calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

1000

uint32

Read/Write

Boot time of sensor/input, in ms

306

132

3

16

2

CT

40

float

Read/Write

CT of current transformer

3.3 Calibration for Sigfox-Ready AC current transducer

Please refer to this link.

4. Product specification

Please refer to the detailed specifications in this link.

5. Warranty and Support

For warranty terms and support procedures, please refer to this link.

6. References

Use-cases:

Case studies:

White-papers:

END.

Manual for Sigfox-Ready Single-Axis Vibration Sensor - WSSFC-V1A | FW3

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Thank you very much for choosing Daviteq Wireless Sensors. We are the leading wireless sensor manufacturer in the World. We have a wide range of wireless sensors which support different connectivity like LoRaWAN, Sigfox, Sub-GHz, NB-IoT...Please find out more information at this link.

This manual is applied to the following products

Item code

HW Version

Firmware Version

Remarks

WSSFC-V1A-025

2H

3F

Product Features

Connectivity Type

Sigfox

Product Type

2 parts

Mounting Type

Direct process mounting for sensor, wall mount for transmitter

Powered by

2 x AA batteries 1.5V

Information Changes in this version v.s previous version

Item

Changes

Changed by

Changed Date

Approved by

Approved Date

1

Initial version

D.Q.Tuan

02-06-2023

N.V.Loc

09-06-2023

To use this product, please refer step by step to the below instructions.

Operating Principle

Uplink Payload

Battery

Connect to Sigfox Network

Installation

Troubleshooting

Configuration

Calibration

Specification

Warranty and Support

1.  Quick Guide

Reading time: 10 minutesFinish this part so you can understand and put the sensor in operation with the default configuration from the factory.

1.1 What is the Sigfox-Ready V1A Single-Axis Vibration Sensor and its principle of operation?

WSSFC-V1A is a cost-effective, single-axis vibration sensor designed for condition monitoring and preventive maintenance applications. The piezo-electric accelerometer is available in ranges ±25g or 50g and features a flat frequency response up to >10kHz. Its accelerometer feature a stable piezo-ceramic crystal in shear mode with low-power electronics, sealed in a fully hermetic package. The Piezo Electric technology incorporated in the WSSCF-V1A accelerometer has a proven track record for offering the reliable and long-term stable output required for condition monitoring applications. The accelerometer is designed and qualified for machine health monitoring and has superior Resolution, Dynamic Range, and Bandwidth to MEMS devices. Besides that, it can also measure the temperature at the mounting point.

It is battery-operated and able to connect to any Sigfox network in the World. It supports all frequency zones such as RC1, RC2, RC3c, RC4, RC5, RC6, and RC7.

For the principle operation of the V1A single-axis vibration sensor, please refer to this link.

1.1.1 What are the typical applications of this sensor?

Please refer to this link for typical applications.

1.1.2 When does the device send uplink messages?

The device will send uplink messages in the following cases:

Case 1: After power-up in the 60s, the device will send the first message called START_UP. The payload will tell the user the HW version, FW version, and current configuration of the device;

Case 2: Then, in every interval time (pre-configured), for example, 10 minutes, it will send the message called CYCLIC_DATA. The payload will tell the user the following data like measured values, battery level, alarm status...

To change the cycle of data sending, you can change the value of the parameter: CYCLIC_DATA_PERIOD (default is 600 seconds).

Case 3: If the Alarm function was enabled (in the configuration of the sensor), if the measured value passed the threshold, it will send the uplink message immediately. This message is called ALARM. The payload also tells the user the data like measured values, battery level, alarm status...

The alarm thresholds can be changed via downlink or offline tools.

Case 4: The HEART_BEAT uplink message will be sent once a day (the default setting can be changed in configuration) to allow the Sigfox back-end system can send the downlink message for changing the configuration of the sensor. Please refer to the downlink section for more details. The uplink payload will tell the user the HW version, FW version, and current configuration of the device;

Case 5: During commissioning, testing, or calibration sensor, the user can force the device to send the uplink message to get the data immediately. This message is called FORCE_DATA. The payload will provide data like raw measured value, scaled measured value, battery level, alarm status... It can be forced by applying the magnet key on the reed switch in 1s;

Case 6: If users want to change the configuration immediately, they don't need to wait up to 1 day for the HEART_BEAT message, instead they can force the device to send a special uplink message so that the device can get the new downlink message. This uplink message is named PARAMETERS_UPDATE. It can be forced by applying the magnet key in more than 5s.

1.1.3 The important configuration parameters

The sensor was pre-configured at the factory with default values for configuration parameters that meet most use cases. However, depending on the specific use case, the customer can adjust those parameters. Please refer to section 3.2 for more details.

1.1.4 What kind of battery is used for this sensor?

The sensor is powered by 2 x AA 1.5V batteries for many years of operation. We do recommend using Energizer L91 battery which is very popular and high performance. This battery has a capacity of up to 3500mAh with a working temperature range from -40 to +60 oC. The instruction for installing the batteries is in this link.

Figure 1. Battery Energizer L91

For Battery life estimation, please refer to this link.

1.2 What's in the package?

The package includes:01 x Main device with 2m M12 cable01 x Magnet key01 x Wall mounting bracket and screws01 x Vibration sensor module V1A

Figure 2. Product package of WSSFC-V1A-025

1.3 Quick Test

With the default configuration, the device can be connected quickly to the Sigfox Network by the following steps.

Step 1: Prepare the values of communication settings:

Device ID

Get Devive ID on the device nameplate

Device PAC

Get Devive PAC on the device nameplate

Note: All Sigfox sensors are pre-configured with the correct RC before delivery. The settings of Device ID, Device PAC, and RC could also be read from the device memory map. Please reference section 3.2 Sensor configuration for details.

Step 2: Add the device to Sigfox Backend

Please refer to this link for details

Step 3: Install the batteries to the device

Please refer to this link for instructions on battery installation.

After installing the battery in 60 seconds, the first data packet will be sent to the Sigfox network. After receiving the first data packet, the time of another packet depends on the value of the parameter: CYCLIC_DATA_PERIOD. Additionally, you can use a Magnet Key to force the device to send data instantly.

Step 4: Decode the payload of receiving package

Please refer to section 1.4 Uplink Payload and Data Decoding for details of decoding the receiving packet to get the measured values.

1.4 Uplink Payload and Data Decoding

For the Uplink Payload structure, please refer to this link.

Note: Please select the right Payload document to suit the FW version of the sensor

1.5 Sensor Installation

1.5.1 Dimension drawings

Figure 3. Dimensions of Sigfox Transmitter

Figure 4. Dimensions of V1A vibration sensor module

1.5.2 Installation

The Sigfox-Ready V1A vibration sensor combines a wireless transmitter WSSFC and a V1A vibration sensor. Therefore, the installation will be divided into 02 parts:

INSTALLATION GUIDE FOR V1A SENSOR MODULE

INSTALLATION GUIDE FOR WIRELESS TRANSMITTER.

PLEASE SEE THE BELOW STEPS.

Mount the wireless transmitter on the wall or a pole nearby the object to monitor the vibration. The wireless transmitter must be mounted at the minimum level of 2m from the ground for a better RF signal. To get the strongest RF signal, please follow this link.

How to mount it with a mounting bracket? please check this guide.

Insert the batteries into the wireless transmitter and check the system to see whether the wireless transmitter already sent the first message to the system. Please follow this link to learn how to install the batteries.

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Connect the M12 cable to the V1A sensor module as below figure.

Figure 5. Complete set of WSSFC-V1A-025 vibration sensor

1.5.3 Device calibration & configuration

Please refer to this link.

2. Maintenance

2.1 Troubleshooting

Problems with Sigfox communication like not receiving the packets...please refer to this link to troubleshoot the device.

Problems with the sensor functions like not measuring or inaccurate measuring....please refer to this link to troubleshoot the sensor part.

2.2 Device maintenance

2.2.1 Maintenance for Wireless transmitter

Maintenance works

Yes/No

Descriptions

Consumable parts replacement

Yes

The battery is the only part need to check the lifetime to replace. Check the battery status on the back-end system.

Cleaning device

No

Re-calibration / Re-validation

No

No calibration is required for the wireless transmitter.

2.2.2 Maintenance for V1A sensor module

Please refer to this link.

3. Advanced Guide

3.1 Operating principle of the Sigfox-Ready V1A Single-axis Vibration Sensor

3.1.1 Operating principle of the complete device

The Daviteq Sigfox-Ready V1A Single-axis Vibration Sensor comprises 02 parts connected together as shown below picture.

- The Daviteq Sigfox-Ready wireless transmitter- The Daviteq V1A vibration sensor module

Figure 6. Complete set of WSSFC-V1A-025 vibration sensor mounted on the motor

The V1A single-axis vibration sensor measures the vibration of the object.

The Sigfox-Ready wireless transmitter is to read the measurement values from the V1A sensor and performs the scaling and calculation to deliver accurate outputs.

3.1.2 Operating principle of V1A single-axis vibration sensor

To understand how the V1A single-axis vibration sensor works, please refer to this link for a complete understanding of this measuring technique.

3.1.3 Some important configuration parameters

Below are some important configuration parameters which affect the operation of the device like battery life, measurement accuracy, and alert threshold.

For Battery life estimation, please refer to this link.

measure_period | Default = 3600sThis is the time period for the wireless transmitter to wake up and take the measurement from the transducer. The default value is 3600s. Users can reduce this value, but smaller value, shorter battery life!

cyclic_data_period | Default = 3600sInterval time to send an uplink message regardless of any conditions

constant_A | Default = calibrated value by factoryThis value will affect the measurement accuracy. DO NOT change this value!

Those configuration parameters can be changed by downlink or offline tools. For more other configuration parameters, please refer to the next section.

3.2 Sensor Configuration

3.2.1 How to configure the Sigfox-Ready V1A Sing-axis Vibration Sensor?

Sensor configuration can be configured in 02 methods:

Method 1: Configuring via Downlink message. Please find the instructions in this link, but please take note of the FW version of the Document.

Method 2: Configuring via offline cable.

Note: THE SENSOR IS ONLY ACTIVE FOR OFFLINE CONFIGURATION IN THE FIRST 60 SINCE POWER UP BY BATTERY OR PLUGGING THE CONFIGURATION CABLE.

3.2.2 What parameters of the device are configured?

Some parameters are read-only, and some are read and writeable.

To read the parameters, use the off-line cable as above instruction.

Via uplink message, users can read only one parameter, which is the CURRENT_CONFIGURATION.

Below tables are the lists of the parameters of the device.

Read-only Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

No. of Registers

Description

Range

Format

Property

Comment

259

103

3

9

SERIAL NUMBER

string

Read

Sensor serial number

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Read/Write Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

Check the Payload Document section: 5.Payload for downlink message for more information

274

112

3

16

1

SERVER_CONFIG

0

uint16

Read/Write

0: Send to Sigfox Network

1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1-4

4

uint16

Read/Write

RC zones selection 1, 2 , 3, 4 is RC1, RC2, RC3s, RC4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value

306

132

3

16

1

ENB_DATGRAM

1

uint16

Read/Write

bit0: enable datagram 0bit1: enable datagram 1bit2: enable datagram 2

307

133

3

16

1

TEMPERATURE_OFFSET_X10

0

int16

Read/Write

Offset adjustment for measured temperature value

308

134

3

16

1

V1A_RANGE_MODE

1

uint16

Read/Write

Mode of vibration frequency rangeMode 0: 10Hz - 10KHzMode 1: 2Hz - 10KHz

309

135

3

16

1

MEASUREMENT_CYCLE_FOR_TIMEOUT

5

uint16

Read/Write

Number of measurement cycle for communication timeout between sensor module and lorawan module

3.3 Calibration for Sigfox-Ready V1A Vibration Sensor

Please refer to this link.

4. Product specification

Please refer to the detailed specifications in this link.

5. Warranty and Support

For warranty terms and support procedures, please refer to this link.

6. References

Use-cases:

Case studies:

White-papers:

END.

Manual for Sigfox Sensors - Type 3

Sigfox Sensors - Type 2 are Sigfox-ready sensor with Exd approved housing like WSSFCEX-PPS, WSSFCEX-GHC, WSSFCEX-G...

Manual for Sigfox-Ready Exd Approved Flammable Gas Sensor - WSSFCEX-GHC | FW2



THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

Thank you very much for choosing Daviteq Wireless Sensors. We are the leading wireless sensor manufacturer in the World. We have a wide range of wireless sensors which support different connectivity like LoRaWAN, Sigfox, Sub-GHz, NB-IoT...Please find out more information at this link.

This manual is applied to the following products

Item code

HW Version

Firmware Version

Remarks

WSSFCEX-GHC-01

1

2

Product Features

Connectivity Type

Sigfox

Product Type

1 part

Mounting Type

Wall mount

Powered by

1 x C battery LiSOCl2, recommend SAFT LS26500

Information Changes in this version v.s the previous version

Item

Changes

Changed by

Changed Date

Approved by

Approved Date

1

Initial version

D.Q.Tuan

29-10-2022

N.V.Loc

31-10-2022

To use this product, please refer step by step to the below instructions.

Operating Principle

Uplink Payload

Battery

Connect to Sigfox Network

Installation

Troubleshooting

Configuration

Calibration

Specification

Warranty and Support

1.  Quick Guide

Reading time: 10 minutesFinish this part so you can understand and put the sensor in operation with the default configuration from the factory.

1.1 What is the Sigfox-Ready GHC Flammable Gas Sensor and its principle of operation?

WSSFCEX-GHC is a Sigfox-Ready sensor with Ex d explosion-proof approve and comes with a built-in high-performance NDIR technology sensor to detect the Hydrocarbon Gas concentration in the air. Ultra-low-power design and smart firmware allow the complete Wireless and Sensor package to run on a single battery type C for 3-5 years or more with 15 minutes update.

It is battery-operated and able to connect to any Sigfox network in the World. It supports all frequency zones such as RC1, RC2, RC3c, RC4, RC5, RC6, and RC7.

Please refer to this link for the flammable gas sensor's principal operation.

1.1.1 What are the typical applications of this sensor?

Please refer to this link for typical applications.

1.1.2 When does the device send uplink messages?

The device will send uplink messages in the following cases:

Case 1: After power-up in the 60s, the device will send the first message called START_UP. The payload will tell the user the HW version, FW version, and current configuration of the device;

Case 2: Then, in every interval time (pre-configured), for example, 10 minutes, it will send the message called CYCLIC_DATA. The payload will tell the user the following data like measured values, battery level, and alarm status...

To change the cycle of data sending, you can change the value of the parameter: CYCLIC_DATA_PERIOD (default is 600 seconds).

Case 3: If the Alarm function was enabled (in the configuration of the sensor), if the measured value passed the threshold, it will send the uplink message immediately. This message is called ALARM. The payload also tells the user the data like measured values, battery level, and alarm status...

The alarm thresholds can be changed via downlink or offline tools.

Case 4: The HEART_BEAT uplink message will be sent once a day (the default setting can be changed in configuration) to allow the Sigfox back-end system can send the downlink message for changing the configuration of the sensor. Please refer to the downlink section for more details. The uplink payload will tell the user the HW version, FW version, and current configuration of the device;

Case 5: During the commissioning, testing, or calibration sensor, the user can force the device to send the uplink message to get the data immediately. This message is called FORCE_DATA. The payload will provide data like raw measured value, scaled measured value, battery level, and alarm status... It can be forced by applying the magnet key on the reed switch in 1s;

Case 6: If users want to change the configuration immediately, they don't need to wait up to 1 day for the HEART_BEAT message, instead they can force the device to send a special uplink message so that the device can get the new downlink message. This uplink message is named PARAMETERS_UPDATE. It can be forced by applying the magnet key in more than 5s.

1.1.3 The important configuration parameters

The sensor was pre-configured at the factory with default values for configuration parameters that meet most use cases. However, depending on the specific use case, the customer can adjust those parameters. Please refer to section 3.2 for more details.

1.1.4 What kind of battery is used for this sensor?

The sensor is powered by 1 x Type C battery 3.6V LiSOCl2 for many years of operation. We do recommend using Saft LS26500 battery which is suitable for Exd-approved instruments. This battery has a capacity of up to 7700mAh with a working temperature range from -40 to +85 oC. The instruction for installing the batteries is in this link.

Note: The battery can be inserted into the device in the Safe Zone only!!!

Figure 1. Battery SAFT LS26500

For Battery life estimation, please refer to this link.

1.2 What's in the package?

The package includes the following items:01 x Main device01 x Magnet key01 x Antenna Type N connector

Figure 2. Product package of WSSFCEX-GHC-01

1.3 Quick Test

With the default configuration, the device can be connected quickly to the Sigfox Network by the following steps.

Step 1: Prepare the values of communication settings:

Device ID

Get Devive ID on the device nameplate

Device PAC

Get Devive PAC on the device nameplate

Note: All Sigfox sensors are pre-configured with the correct RC before delivery. The settings of Device ID, Device PAC, and RC could also be read from the device memory map. Please reference section 3.2 Sensor configuration for details.

Step 2: Add the device to Sigfox Backend

Please refer to this link for details

Step 3: Install the batteries to the device

Please refer to this link for instructions on battery installation.

After installing the battery in 60 seconds, the first data packet will be sent to the Sigfox network. After receiving the first data packet, the time of another packet depends on the value of the parameter: CYCLIC_DATA_PERIOD. Additionally, you can use a Magnet Key to force the device to send data instantly.

Step 4: Decode the payload of receiving package

Please refer to section 1.4 Uplink Payload and Data Decoding for details of decoding the receiving packet to get the measured values.

1.4 Uplink Payload and Data Decoding

For the Uplink Payload structure, please refer to sections B and C in this link.

1.5 Sensor Installation

1.5.1 Dimension drawings

Figure 3. Dimensions

1.5.2 Device calibration & configuration

If Configuration and Calibration are needed for the device, please perform those tasks in the Safe zone, before installing the device at the site.

Please refer to this link.

1.5.3 Installation

The Sigfox-Ready GHC flammable gas sensor is a wireless device with an integrated gas sensor to detect combustible gas.

1.5.3.1 Preparation before installing the device at the site location:

Insert the batteries into the device in Safe Zone;

ATTENTION: REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Make sure the device run and connect to the Sigfox Network successfully;

1.5.3.2 Installing the device at the actual location as below steps:

Locate the place to detect the target gas. Please follow this link;

Make sure the site is good enough for RF signal transmission. Please take notes as in this link;

Mount the sensor onto a wall by two screws as this link;

Note: DO NOT OPEN THE DEVICE OR REPLACING BATTERY DURING INSTALLATION AT SITE (HAZARDOUS AREA ZONE  0, 1, 2)

2. Maintenance

2.1 Troubleshooting

Problems with Sigfox communication like not receiving the packets...please refer to this link to troubleshoot the device.

Problems with the sensor functions like not measuring or inaccurate measuring....please refer to this link to troubleshoot the sensor part.

2.2 Device maintenance

2.2.1 Maintenance for Wireless transmitter

Maintenance works

Yes/No

Descriptions

Consumable parts replacement

Yes

The battery is the only part need to check the lifetime to replace. Check the battery status on the back-end system.

Cleaning device

No

2.2.2 Maintenance for GHC sensor module

Please refer to this link.

3. Advanced Guide

3.1 Operating principle of the Sigfox-Ready GHC Flammable Gas Sensor

3.1.1 Operating principle of the complete device

The Daviteq Sigfox-Ready GHC Flammable Gas Sensor comprises 02 parts connected together:

- The Daviteq Sigfox-Ready wireless transmitter- The Daviteq GHC flammable sensor module

Figure 4. Complete set of WSSFCEX-GHC flammable gas sensor

The GHC flammable gas sensor measures the flammable gas concentration of the surrounding air.

The Sigfox-Ready wireless transmitter is to read the measurement values from the GHC sensor and performs the scaling and calculation to deliver accurate outputs.

3.1.2 Operating principle of GHC flammable gas sensor

To understand how the GHC flammable gas sensor works, please refer to this link for a complete understanding of this measuring technique.

3.1.3 Some important configuration parameters

Below are some important configuration parameters which affect the operation of the device like battery life, measurement accuracy, and alert threshold.

For Battery life estimation, please refer to this link.

measure_period | Default = 300sThis is the time period for the wireless transmitter to wake up and take the measurement from the transducer. The default value is 3600s. Users can reduce this value, but smaller value, shorter battery life!

cyclic_data_period | Default = 1800sInterval time to send an uplink message regardless of any conditions

sensor_response_time | Default = 100sThis value will affect the measurement accuracy. DO NOT change this value!

Those configuration parameters can be changed by downlink or offline tools. For other configuration parameters, please refer to the next section.

3.2 Sensor Configuration

3.2.1 How to configure the Sigfox-Ready GHC flammable gas sensor?

Sensor configuration can be configured in 02 methods:

Method 1: Configuring via Downlink message. Please find the instructions in sections D and E in this link, but please take note of the FW version of the Document.

Method 2: Configuring via offline cable.

Note: THE SENSOR IS ONLY ACTIVE FOR OFFLINE CONFIGURATION IN THE FIRST 60 SINCE POWER UP BY BATTERY OR PLUGGING THE CONFIGURATION CABLE.

3.2.2 What parameters of the device are configured?

Some parameters are read-only, and some are read and writeable.

To read the parameters, use the off-line cable as per the above instruction.

Via uplink message, users can read only one parameter, which is the CURRENT_CONFIGURATION.

The below tables are the lists of the parameters of the device.

Read-only Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

No. of Registers

Description

Range

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Read/Write Parameter Table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

Check sections D & E in thisPayload Document

274

112

3

16

1

SERVER_CONFIG

0

uint16

Read/Write

0: Send to Sigfox Network

1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1-4

4

uint16

Read/Write

RC zones selection 1, 2 , 3, 4 is RC1, RC2, RC3s, RC4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value. This value would be changed after calibration.

280

118

3

16

2

CONSTANT_B

0

float

Read/Write

Constant b for scaling measured value.This value would be changed after calibration.

306

132

3

16

1

SENSOR_RESPONSE_TIME

100

uint16

Read/Write

Sensor response time, in second

307

133

3

16

2

C_H_FACTOR

4.4

float

Read/Write

For methane C(h) = 4.4% vol; for propane C(h) = 1.7% vol

3.3 Calibration for Sigfox-Ready GHC Flammable Gas Sensor

Please refer to this link.

4. Product specification

Please refer to the detailed specifications in this link.

5. Warranty and Support

For warranty terms and support procedures, please refer to this link.

6. References

Use-cases:

Case studies:

White-papers:

END.

USER GUIDE FOR SIGFOX PIEZO-ELECTRIC 10KHZ VIBRATION SENSOR WSSFC-V1A

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC-V1A-MN-EN-01

MAY-2021

This document is applied for the following products

SKU

WSSFC-V1A

HW Ver.

1.1

FW Ver.

1.0

Item Code

WSSFC-V1A-9-01

SIGFOX PIEZO-ELECTRIC 10KHZ VIBRATION SENSOR, +/- 25G, INTERNAL ANTENNA, TYPE AA BATTERY 1.5VDC, IP67, RC2-RC3-RC4-RC5 ZONES

WSSFC-V1A-8-01

SIGFOX PIEZO-ELECTRIC 10KHZ VIBRATION SENSOR, +/- 25G, INTERNAL ANTENNA, TYPE AA BATTERY 1.5VDC, IP67, RC1-RC6-RC7 ZONES

0. Configuration Check List

STEP 1: Select RC

1. Select RC zone using Modbus Configuration Cable

RC zones selection 1, 2, 4 is RCZ1, RCZ2, RCZ4  (refer to register address 270)

2. Select RC zone using button

Refer to the button configuration

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section using the Modbus Configuration Cable

STEP 4:  Add device to Backend Sigfox

refer to section 5.4 for details

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.1

1.0

DEC-2020

2. Introduction

WSSFC-V1A is a cost effective, Sigfox accelerometer single-axis vibration sensor designed for condition monitoring and preventive maintenance applications. The piezo-electric accelerometer is available in ranges ±25g or 50g and features a flat frequency response up to >10kHz. Its accelerometer feature a stable piezo-ceramic crystal in shear mode with low power electronics, sealed in a fully hermetic package. The Piezo Electric technology incorporated in the WSSCF-V1A accelerometer has a proven track record for offering the reliable and long-term stable output required for condition monitoring applications. The accelerometer is designed and qualified for machine health monitoring and has superior Resolution, Dynamic Range and Bandwidth to MEMS devices. Beside that it can also measure the temperature at mounting point. With Ultra-low power design and smart firmware allow the complete Wireless and Sensor package run on 2 x AA battery up to 10 years. It can support all regions of Sigfox network in over the World, RC1, RC2, RC3, RC4, RC5, RC6, RC7.

3. Specification

SENSOR SPECIFICATION

Sensor technology

Hermetically Sealed, Piezo-Ceramic Crystal, Shear Mode

Acceleration Range and Shock Limit (g)

±25 or 50, 10,000

Frequency Response and Resonant Frequency (Hz)

2-10000, >30000

Non-Linearity, Transverse Sensitivity

±2%FSO, < 5%

Temperature measuring and operating range, accuracy & resolution (°C)

-40.. +85, +/- 0.5, 0.125

Sensor Material, mousing protection and mounting

304SUS, IP67, M6 Screw

*Notes

All above values are typical at +24°C, 80Hz

Connector

M12-M 4-pin, Coding A

Extended cable (optional)

2m cable with M12-F and M12-M at two ends

SIGFOX SPECIFICATION

Sigfox zones

select RC2-RC3-RC4-RC5 or RC1-RC6-RC7

Antenna

Internal Antenna 2 dbi

Configuration

via offline USB cable (PC software is supplied at free)

Battery

02 x AA Type 1.5VDC, working time up to 10 years (depends on configuration)

RF Module complies to

CE, FCC, ARIB

Working temperature

-40oC..+60oC (using Energizer Lithium Ultimate AA battery)

Dimensions

H106xW73xD42

Net-weight

190 grams

Housing

Aluminum+Polycarbonate, IP67

Mounting

Wall mount bracket

4. Dimensions

5. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol).

After that, Sigfox node will send the first message to Base station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent.

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 15s. if shorter than 15s, there will be no data sending and you will not hear the beep sound.

5.1 LED meaning

Whenever the data is sent to base station, the LED will lit with color codes as below:

RC1: RED colour

RC2: GREEN colour

RC4: BLUE colour

5.2 Button Function

the push button can only be used for the first 60 seconds after powering up.

5.2.1 Menu configuration

There are 3 configuration menus: tx_repeat, downlink_flag, radio configuration.

We use the button to enter the menus as follows:

5.2.1.1 tx_repeat

Press and hold the button 2s  ->  When the Red LED is on, it means entering the tx_repeat configuration menu. Then release to configure it.

Press to configure. After pressing if the Red LED flashes once, tx_repeat = 0 (send 1 time). After pressing if the Red LED blinks twice, it is tx_repeat = 1 (send 3 times).

5.2.1.1 downlink_flag

Press and hold the button 5s  ->  When the Green LED is on, it means entering the downlink_flag configuration menu. Then release to configure it.

Press to configure. After pressing if the Green LED flashes once, it is downlink_flag = 0 (downlink is not allowed). After pressing if the Red LED blinks twice, it is downlink_flag = 1 (downlink is allowed).

5.2.1.1 radio configuration

Press and hold the button 10s  ->  Blue LED is on, it means entering the Radio Configuration menu. Then release to configure it.

Press to configure. After pressing if the Blue LED blinks once, it is Radio Configuration = 1. After pressing if the Blue LED flashes twice, it is Radio Configuration = 2. After pressing if the Blue LED flashes 4 times, it is Radio Configuration = 4.

5.2.2 Exit the menu:

There are 3 ways to exit the menu:

Press and hold for 3s, the LED turns off to exit the menu;

Wait 30 seconds, then exit the menu;

Take out the battery, it all starts over (outside the menu)).

5.3 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC4

Uplink center frequency (MHz)

868.130

902.200

920.800

Downlink center frequency (MHz)

869.525

905.200

922.300

Uplink data rate (bit/s)

100

600

600

Downlink data rate (bit/s)

600

600

600

Sigfox recommended EIRP (dBm)

16

24

24

Specifics

Duty cycle 1% *

Frequency hopping **

Frequency hopping **

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

5.4 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

5.5 Measurement principle of Sigfox Vibration Sensor

When the time interval is reached, for example 30 minutes, the Sigfox node will wake up and switch ON the power supply to supply the energy to vibration sensor module to start the measurement. Depends on the type and characteristic of external sensor, the sensor will take a certain time to finish the measurement.

With vibration sensor, here are the 8 measurement values:

Acceleration Peak (m/s2)

Acceleration RMS (m/s2)

Velocity Peak (mm/s)

Velocity RMS (mm/s)

Displacement Peak-Peak (um)

Displacement RMS (um)

Base vibration frequency (Hz)

Temperature (oC)

Because the Payload of Sigfox sensor is limited by 12 bytes, we use the first 02 bytes for Sensor information and status, the rest 10 bytes will store measurement value. With above 8 measurement values, we have to device it into 03 datagrams. Each datagram will be sent each time.

Values to be sent in Datagram 1:

Velocity RMS (mm/s)

Acceleration Peak (mm/s)

Frequency (Hz)

Values to be sent in Datagram 2:

Velocity Peak (mm/s)

Acceleration RMS (m/s2)

Temperature (oC) (Real Temperature value = Temperature value / 10)

Values to be sent in Datagram 3:

Displacement Peak-Peak (um)

Displacement RMS (um)

Frequency (Hz)

User can configure the Sigfox node to send any number of datagram, but minimum is Datagram 1. The configuration can be done offline via cable & software OR via downlink.

5.6 Payload Data

The following is the format of payload data will be sent to Sigfox server.

5.6.1 Payload for uplink 12 bytes

Sensor type (1 byte)

Status + Datagram (1 byte)

Parameter 1 (4 bytes)

Parameter 2 (4 bytes)

Parameter 2 (2 bytes)

Meaning of Data in the Payload

Data

Size

Bit

Format

Meaning

Sensor type

1 byte

all

Uint8

Sensor type:

0x10 means Sigfox V1A

0xFF means no sensor.

Status: battery level

2 bits

Bit 7 and 6

Battery capacity in 04 levels

11: battery level 4 (99%)

10: battery level 3 (60%)

01: battery level 2 (30%)

00: battery level 1 (10%)

Status: error

2 bits

Bit 5 and 4

Node status

01: error

00: no error

Datagram

4 bits

Bit 3 to 0

Datagram 000 : Datagram 1 001 : Datagram 2010 : Datagram 3

Parameter 1

4 bytes

all

Float

Datagram 1 : Velocity RMS (mm/s)Datagram 2 : Velocity Peak (mm/s)

Datagram 3 : Displacement Peak-Peak (um)

Parameter 2

4 bytes

all

Float

Datagram 1 : Acceleration Peak (mm/s)Datagram 2 : Acceleration RMS (m/s2)

Datagram 3 : Displacement RMS (um)

Parameter 3

2 bytes

all

Datagram 1 : uint16;

Datagram 2 : int16;

Datagram 3 : uint16

Datagram 1 : Frequency (Hz)Datagram 2 : Temperature (oC)

Real Temperature value = Temperature value / 10

Datagram 3 : Frequency (Hz)

5.6.2 Payload for Downlink, length is 8 bytes.

The Sigfox node is only able to receive max 04 downlinks a day, each downlink will be waiting in every 06 hours.

User can set the down link data in Sigfox back-end system in advance, whenever the Sigfox node connected to base stations and with downlink waiting is enable at that time (one time in 6 hours), the downlink data will be loaded to Sigfox node.

The downlink data can be any configuration parameter.

Please pay attention when send downlink data. If there was a mistake in sending wrong data, it would cause the Sigfox node not working properly and user need to configure it by offline cable!!!

Downlink payload format:

Prm_adr (1 byte)

Prm_len (1 byte)

Prm_value (6 bytes)

Examples of Downlink data to configure the Sigfox node:

Prm_name

Prm_adr

Prm_len

Comment

cycle_send_data

0x12

0x04

to configure the interval time of data sending, in seconds.

Enb_datagram

0x44

0x02

to configure which datagram to be sent.

Explain for Enb_datagram:

bit 0 = 1: enable datagram 1

bit 0 = 0: disable datagram 1

bit 1 = 1: enable datagram 2

bit 1 = 0: disable datagram 2

bit 2 = 1: enable datagram 3

bit 2 = 0: disable datagram 3

Some examples of Enb_datagram:

Enb_datagram = 0x0000 ==> Only datagram 1 will be sent.

Enb_datagram = 0x07 = 0b00000111 ==> Enable 3 datagrams

At 1st cycle_send_data , Sigfox V1A will send datagram 1

At 2nd cycle_send_data , Sigfox V1A will send datagram 2

At 3rd cycle_send_data , Sigfox V1A will send datagram 3

At 4th cycle_send_data , Sigfox V1A will send datagram 1 and so on.

Enb_datagram = 0x05 = 0b00000101 ==> Enable datagram 1 and 3, disable datagram 2

At 1st cycle_send_data , Sigfox V1A will send datagram 1

At 2nd cycle_send_data , Sigfox V1A will send datagram 3

At 3rd cycle_send_data , Sigfox V1A will send datagram 1

At 4th cycle_send_data , Sigfox V1A will send datagram 3 and so on.

6. Offline configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=qK0PGNbY1g1fuxTqbFW9SXtEvCw7bpc6

How to use the Modbus configuration software

Step 2: Plug the configuration cable to Computer via USB port;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-V1A.csv

Here is the table of Data will be read by Modbus tool

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

0

0

3

2

device info

string

Read

Product name

2

2

3

4

firmware version

string

Read

6

6

3

2

hardware version

string

Read

8

8

3

2

device ID

hex

Read

Product ID

10

A

3

4

device PAC

hex

Read

Product PAC

14

E

3

1

sen_type

1-255

uint16

Read

Sensor or Input Type

15

F

3

1

batt level

0-3

uint16

Read

Battery level

16

10

3

1

err_status

0-1

uint16

Read

Sensor error code

23

17

3

1

batt %

10%, 30%, 60%, 99%

uint16

Read

Battery %

24

18

3

2

batt volt

0-3.67 vdc

float

Read

Battery Voltage

26

1A

3

2

temp

oC

float

Read

RF module temperature

28

1C

3

1

vref

0-3.67 vdc

uint16

Read

Vref of RF Module

29

1D

3

1

btn1 status

0-1

uint16

Read

Button status, 0: released, 1: pressed

30

1E

3

1

btn2 status

0-1

uint16

Read

Reedswitch status, 0: opened, 1: closed

Here is the table for Configuration:

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

1

Radio Configuration

1-6

4

uint16

Read/

Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

271

10F

3

16

1

tx_power

20

int16

Read/

Write

RF Tx power

272

110

3

16

1

tx_repeat

0-1

1

uint16

Read/

Write

Number of repeat, 0: 1 time, 1: 3 repeats

273

111

3

16

1

downlink_flag

0-1

0

uint16

Read/

Write

1: enable Downlink, 0: disable Downlink (Fw v1.0 hasn't got Downlink function)

274

112

3

16

2

cycle_send_data

900

uint32

Read/

Write

Data sending cycle, in seconds

278

116

3

16

1

alarm_limit

44

uint16

Read/

Write

Limit number of alarm sending in 24h

280

118

3

16

2

sensor1: sampling_rate

120

uint32

Read/

Write

Sensor/Input 1 sampling rate, in seconds

282

11A

3

16

2

sensor1: calc_time

100

uint32

Read/

Write

Measurement time of sensor/input 1, in ms

324

144

3

16

1

enb_datagram

0x0001

hex

Read/

Write

bit 0 = 1: enb datagram 1bit 0 = 0: dis datagram 1bit 1 = 1: enb datagram 2bit 1 = 0: dis datagram 2bit 2 = 1: enb datagram 3bit 2 = 0: dis datagram 3enb_datagram = 0x0000: emb datagram 1

7. Installation

7.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

7.2 Process mounting

WARNING:

The sensor should be mounted on an oil-free and grease-free surface as close to the source of vibration as possible.

For best results, the sensor should be mounted via a drill hole and have an M6x1.0 threaded hole (an adapter can be used) attached directly to the housing.

Please make sure that the operating ambient temperature is within the specification of sensor.Prepare the professional tools for installation. The inappropriate tools may cause damage to the sensor.

DANGER: Do not twist the upper part of sensor, only screwing the sensor by using the HEX wrench with the lower HEX part of sensor.

7.3 Battery installation

Steps for battery installation:

Step 1: Using L hex key to unscrew M4 screws at the side of the housing and carefully pull out the top plastic housing in the vertical direction

Step 2: Insert 02 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing and locking by L hex key

ATTENTION:When reinstalling the cover, pay attention to put the PCB edge into the middle slot of the box inside as shown below)

8. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply or battery ran out

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Or place the Magnet key not right position

Locate the correct position for magnet key

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages of uplink per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

Contact manufacturer

6

The measurement values from sensor do not change, keep constant values for long time

Sensor got failure

Sensor cable broken

Sensor connector is not connected firmly

Check sensor cable and connector

If the issue is still exist, please contact manufacturer for warranty or replace new sensor

7

The node does not send RF and the RF module is hot

Insert the battery in the wrong direction

Electronics got problem

Check battery polarity

8

RSSI is weak and often loses data

Distance between Node and Base station is far or there are many obstructions

Connection to Antenna problem

Check location of Sigfox node and distance to base station

Check the antenna connector in the PCB

9. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

USER GUIDE FOR SIGFOX LIDAR PEOPLE COUNTER WSSFC-LPC

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC-LPC-MN-EN-01

AUG-2021

This document is applied for the following products

SKU

WSSFC-LPC

HW Ver.

1.1

FW Ver.

1.0

Item Code

WSSFC-LPC-9-01

SIGFOX LIDAR PEOPLE COUNTER, INTERNAL ANTENNA, TYPE AA BATTERY 1.5VDC, IP5X, RC2-RC3-RC4-RC5 ZONES

WSSFC-LPC-8-01

SIGFOX LIDAR PEOPLE COUNTER, INTERNAL ANTENNA, TYPE AA BATTERY 1.5VDC, IP5X, RC1-RC6-RC7 ZONES

0. Configuration Check List

STEP 1: Select RC

1. Select RC zone

RC zones selection 1, 2, 4,... is RCZ1, RCZ2, RCZ4,...  (refer to section 6)

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section 5 and section 6

STEP 4:  Add device to Backend Sigfox

refer to section 5.2 for details

STEP 5:  Installation

refer to section 7  for details

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.1

1.0

DEC-2020

2. Introduction

WSSFC-LPC is a Sigfox sensor with built-in advanced Lidar sensor to detect and ranging people. It can count the people walk thru with accuracy higher than 90%. The sensor is not affected by temperature, humidity, RF noise and less affected by ambient light... With Ultra-low power design and smart firmware allow the complete Wireless and Sensor package run on AA battery 1.5V in many years. Moreover, it can be powered by external power supply at the same time. It can support all regions of Sigfox network in over the World, RC1, RC2, RC3, RC4, RC5, RC6, RC7.

Typical Applications: People counter for public toilet, People counter for Store, shop...

3. Specification

SENSOR SPECIFICATION

Sensor technology

Lidar

Detection range

max 4m

Detection cone

27 degree

Working temperature

-40 .. + 60 oC

Working humidity

0 .. 100% RH, non-condensing

SIGFOX SPECIFICATION

Sigfox zones

select RC2-RC3-RC4-RC5 or RC1-RC6-RC7

Functions

Sending data in interval or when alarms occur

Antenna

Internal Antenna 2 dbi

Configuration

via offline USB cable (PC software is supplied at free)

Battery

Battery AA Type 1.5VDC and 7..48VDC (AC adapter not included

RF Module complies to

CE, FCC, ARIB

Working temperature

-40°C..+60oC (using Energizer Lithium Ultimate AA battery)

Dimensions

H120xW80xD45

Net-weight

≺150 grams

Housing

Self-extinguisher ABS, Dust and vapor protection

Mounting

Ceiling mount

4. Dimensions

5. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol)

After 1 minute 30 seconds later the device will send the first data packet and at the same time wait for the downlink packet from the Base Station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent. (Buzzer will be updated in the latest version)

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 15s. if shorter than 15s, there will be no data sending.

5.1 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC3

RC4

RC5

RC6

RC7

Uplink center frequency (MHz)

868.130

902.200

923.200

920.800

923.300

865.200

868.800

Downlink center frequency (MHz)

869.525

905.200

922.200

922.300

922.300

866.300

869.100

Uplink data rate (bit/s)

100

600

100

600

100

100

100

Downlink data rate (bit/s)

600

600

600

600

600

600

600

Sigfox recommended EIRP (dBm)

16

24

16

24

14

16

16

Specifics

Duty cycle 1% *

Frequency hopping **

Listen Before Talk ***

Frequency hopping **

Listen Before Talk ***

Duty cycle 1% *

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

5.2 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

5.3 Measurement principle of Sigfox People Counter

5.3.1 Overview

5.3.1.1 MCU Counter counts people in and out

Normally MCU Counter will be in sleep state, PIR Sensor works with low current, Laser Sensor is in power off state.

When someone approaches, PIR Sensor will wake up MCU Counter → MCU Counter power on Laser Sensor →

Laser Sensor returns the measured distance value from the Laser Sensor (mounted on the ceiling) to the nearest obstacle down to the floor.

Dist_threshold mechanism:

The sensor will measure the distance from the sensor (on the ceiling) to the floor, when there is an obstacle, the person is under the sensor, the sensor will measure the distance from the sensor to the obstacle, that person => will get the DistX  value

When DistX < Dist_threshold, the sensor detects that someone is standing below

When DistX > Dist_threshold + dist_hys, the sensor confirms that no one is under

MCU Counter performs counting people in and out based on the principle of counting people in below.

When there are no people nearby, the MCU Counter will power off the Laser Sensor, and the MCU Counter will also sleep.

5.3.1.2 MCU Sigfox

Normally the Sigfox MCU sleeps.

When it comes to the sampling_rate cycle, the Sigfox MCU wakes up reading the Counters values ​​from the MCU Counter. Read-in values ​​include NRC_People_in, NRC_People_out, Dist_front_zone, Dist_back_zone.

The Sigfox MCU will calculate the RC_People_in, RC_People_out based on saving the last NRC_People_in, NRC_People_out values ​​before sending to the Sigfox Server. RC_People_in = NRC_People_in (recently read) - NRC_People_in (saved). NRC_People_out = NRC_People_out (recently read) - NRC_People_out (saved).

If (RC_People_in > count_threshold) or (RC_People_out > count_threshold) then the Sigfox MCU will send the Uplink to the Sigfox Server. Then will delete RC_People_in and RC_People_out to 0. MCU Sigfox will save the last NRC_People_in, NRC_People_out values ​​before sending to Sigfox Server.

When the cycle_send_data is reached, the Sigfox MCU wakes up reading the Counters values ​​from the MCU Counter, calculates the new RC_People_in, RC_People_out and sends the Uplink to the Sigfox Server. Then will delete RC_People_in and RC_People_out to 0. MCU Sigfox will save the last NRC_People_in, NRC_People_out values ​​before sending to Sigfox Server.

5.3.2 The principle of counting people

5.3.2.1 Overview

Counting people with the VL53L1X consists of using the multiple zones of the sensor receiving SPAD area, and of configuring it with two distinct fields of view (FoV), to alternatively get a ranging distance from them and consequently recognize the movements of a person. Using this method, the number of people occupying a meeting room, accessible from a reasonably narrow access, is known at all times by detecting the entrances and exits of the attendees.

By measuring and analyzing the distances of targets within the FoVs of a front and back zone (see figure below and Figure 3. Front and back zones), a simple algorithm can detect the direction a person crosses the area under the two FoVs. This algorithm "understands" that someone is under one of the FoV as long as the distance measured by the sensor under this FoV is between 0 and a threshold value specified in mm.

From a timing perspective, the sensor alternatively ranges on each of the two zones, for a very short period of time in milliseconds. It is possible to determine in which direction a person crosses the area, depending in which order this person has been detected in the two zones, as shown in the figure below.

5.3.2.2 Algorithm description

The counting algorithm example relies on a list of states that have to occur in a certain order to detect if a person has crossed the specified area and in which direction this area has been crossed. These states are stored in a list and compared to two default lists of states that represent how the area is crossed in two different directions. When no-one is seen in either of the two zones, the list of states is reset.

If we consider that a person detected in the front zone equals 2, and a person detected in the back zone equals 1, the algorithm adds the value of the two states and stores the result as soon as it changes.

Eventually, if the consecutive states in the list are 0, 1, 3, 2, 0 or 0, 2, 3, 1, 0 this means a person has been detected in one direction or the other, as described in Figure 4. List of status values.

5.3.2.3 Hysteresis

The algorithm validates a crossing event only when a person has fully crossed the two zones. It does not validate the event when the person remains for a long time under the FoV or when the person decides to return from the place he came from.

This is illustrated in the figure below: the algorithm stops and the list of states is reset as soon as no-one is detected in any of the two FoVs.

5.3.2.4 Ranging on the floor to determine the threshold

Reliability of the algorithm relies on the accuracy of the setup which detects the distance between the sensor and the floor. This can be ensured only if nothing (e.g. no obstacle or static object) blocks the front and back FoVs. To assess if a setup is reliable, a significant number of distances can be measured with the sensor. Then, a histogram diagram can be established to confirm that the sensor is correctly set up and that no target is within its FoVs.

A threshold needs to be defined, which is achieved after having ranged on the flooring material over a significant number of samples. In fact, the threshold should be chosen so that all the measured distances (when ranging the floor) are greater than this threshold. We recommend that at installation of the application, an autocalibration routine is launched to calculate the threshold. This is because flooring material can be different in many locations.

Figure 6. People counting at 2345 mm distance from the floor. The distance between the sensor and the floor is 2345 mm, and as the minimum distance measured by the sensor is 2290 mm, the threshold is thus less than 2290 mm.

Note: This calibration should be performed in the worst ambient light conditions, to maximize the jitter and obtain a threshold that is relevant to all possible ambient lighting conditions the counting setup is exposed to.

5.4 Payload Data

The folllowing is the format of payload data will be sent to Sigfox server.

5.4.1 Payload for uplink 12 bytes

Sensor type

(1 byte)

Status

(1 byte)

NRC_People_in (2 bytes)

NRC_People_out (2 bytes)

RC_People_in (1 byte)

RC_People_out (1 byte)

Dist_front_zone

(2 bytes)

Dist_back_zone

(2 bytes)

Meaning of Data in the Payload

Data

Size (byte)

Bit

Format

Meaning

Sensor type = 0x13

1

all

Uint8

Sensor type = 0x13 means Sigfox People Counter

Status: battery level

1

Bit 7 and 6

Uint8

Battery capacity in 04 levels

11: battery level 4 (99%)

10: battery level 3 (60%)

01: battery level 2 (30%)

00: battery level 1 (10%)

Status: error

Bit 5 and 4

Node status

01:  hardware sensor error

00: no error

NRC_People_in

2

all

Uint16

Non-resettable counter

NRC_People_out

2

all

Uint16

Non-resettable counter

RC_People_in

1

all

Uint8

Reset to 0 after sending to Sigfox server

RC_People_out

1

all

Uint8

Reset to 0 after sending to Sigfox server

Dist_front_zone

2

all

Uint16

Distance of front zone

Dist_back_zone

2

all

Uint16

Distance of back zone

5.4.2 Payload for Downlink, length is 8 bytes

The Sigfox node is only able to receive max 04 downlinks a day, each downlink will be waiting in every 06 hours.

User can set the down link data in Sigfox back-end system in advance, whenever the Sigfox node connected to base stations and with downlink waiting is enable at that time (one time in 6 hours), the downlink data will be loaded to Sigfox node.

The downlink data can be any configuration parameter.

Please pay attention when send downlink data. If there was a mistake in sending wrong data, it would cause the Sigfox node not working properly and user need to configure it by offline cable!!!

Downlink payload format:

Prm_adr (1 byte)

Prm_len (1 byte)

Prm_value (6 bytes)

Prm_name

Prm_adr

Prm_len

Comment

cycle_send_data

0x12

0x04

Count_threshold

0x44

0x02

Dist_threshold

0x46

0x02

Examples of Downlink data to configure the Sigfox node

Example 1: Write down cycle_send_data = 30 minutes

Convert minutes to seconds:   30 minutes = 30 *60 = 1800 seconds

Convert 1800 from DEC to HEX => 0x00000708 (4 bytes)

=> Downlink will be 1204000007080000, where is:

Prm_adr

Prm_len

Prm_value

(remainder doesn't matter)

12

04

00000708

0000

Example 2: Write down Count_threshold = 10

Convert 10 from DEC to HEX to 0x000A (2 bytes)

=> Downlink will be 4402000A00000000, where is:

Prm_adr

Prm_len

Prm_value

(remainder doesn't matter)

44

02

000A

00000000

6. Offline configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=yDOjE5d6kqFlGNVVlMdFg19Aad6aw0Hs

How to use the Modbus configuration software

Step 2: Plug the configuration cable to Computer via USB port;

Step 3: Open the housing by using flat head screws to push into 2 reed joints;

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-LPC.csv

6.1 Data table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

0

0

3

2

device info

string

Read

Product name

2

2

3

4

firmware version

string

Read

6

6

3

2

hardware version

string

Read

8

8

3

2

device ID

hex

Read

Product ID

10

A

3

4

device PAC

hex

Read

Product PAC

6.2 Configuration table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

1

Radio Configuration

1, 2, 4

4

uint16

Read/

Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

271

10F

3

16

1

tx_power

20

int16

Read/

Write

RF Tx power

272

110

3

16

1

tx_repeat

0-1

1

uint16

Read/

Write

Number of repeat, 0: 1 time, 1: 3 repeats

273

111

3

16

1

downlink_flag

0-1

1

uint16

Read/

Write

1: enable Downlink, 0: disable Downlink

274

112

3

16

2

cycle_send_data

sec

3600

uint32

Read/

Write

Data sending cycle, in seconds

280

118

3

16

2

sampling_rate

sec

120

uint32

Read/

Write

Sensor/Input 1 sampling rate, in seconds

324

144

3

16

1

count_threshold

20

hex

Read/

Write

threshold count on how many people send sigfox

325

145

3

16

1

distThreshold

1600

uint16

Read / Write

Threshold setting for laser sensor to distinguish between when people are present and when no one is standing under the sensorThe laser sensor will measure the distance value from the sensor (ceiling) to the floor.

When there are people, the measured laser sensor value < distThreshold

When there is no person, the measured laser sensor value > distThreshold

326

146

3

16

1

distHys

100

uint16

Read / Write

Hys of distThreshold

327

147

3

16

1

inter_meas_period

48

uint16

Read / Write

The sampling time of the sensor laser

7. Installation

7.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

7.2 Mounting

Installation method: Mount to the ceiling

Locate the mounting position at the entrance where people pass by, and out of direct sunlight

The direction of the triangle is the direction of counting people entering as specified in the payload

Determine the correct orientation to install the bottom cover to the ceiling in the correct direction

WARNING: 

Avoid placing hands or heavy objects on the laser sensor surface or the PIR sensor surface, as this may cause damage to the device;

Periodically use a clean cloth moistened with 70 degrees of alcohol to wipe the surface of the 2 sensors to keep the sensor clean and accurate.

Step 1: Determine the direction of people entering the room of the sensor

Step 2: Mount the bottom housing of the sensor to the ceiling by fasten the 2 screws to the ceiling located at the 2 diagonal corners of the bottom cover.

Use the 2 screws that are included to be used to attach the sensor to surfaces such as: Wood, composite plastic.

If the ceiling surface is made of plaster, it is recommended to use a special insert so that the device can firmly adhere to the ceiling surface. Avoid dropping the device.

Step 3: Attach the top and bottom housings (note the 2 reed joint)

Fit the main body to the bottom cover in the correct direction: the 2 reed joints on the bottom cover should fit into the main body on the side labeled with the device.

Make sure that the main body is fully engaged with the bottom cover, then release the hand.

7.3 Battery installation

Steps for battery installation:

Step 1: Using flat head screws to push into 2 reed joints

Step 2: Open the housing, then insert 06 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing (Please note the 2 reed joint)

8. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply or battery ran out

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Or place the Magnet key not right position

Locate the correct position for magnet key

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages of uplink per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

Contact manufacturer

6

The measurement values from sensor do not change, keep constant values for long time

Sensor got failure

Sensor cable broken

Sensor connector is not connected firmly

Check sensor cable and connector

If the issue is still exist, please contact manufacturer for warranty or replace new sensor

7

The node does not send RF and the RF module is hot

Insert the battery in the wrong direction

Electronics got problem

Check battery polarity

8

RSSI is weak and often loses data

Distance between Node and Base station is far or there are many obstructions

Connection to Antenna problem

Check location of Sigfox node and distance to base station

Check the antenna connector in the PCB

9. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

USER GUIDE FOR SIGFOX SENSOR WITH ANALOG INPUT WSSFC-AI

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC-AI-MN-EN-01

 

FEB-2020

This document is applied for the following products

SKU

WSSFC-AI

HW Ver.

2.4

FW Ver.

1.9.3

Item Code

WSSFC-AI-9-01

Sigfox Sensor with Analog input 0-20mA or 0-10VDC, pre-calibrated, Internal antenna, Type C battery 1.5 - 3.6VDC, IP67, M12-M for sensor connection, M12-F for external power supply, RC2-RC3-RC4-RC5 zones

WSSFC-AI-8-01

Sigfox Sensor with Analog input 0-20mA or 0-10VDC, pre-calibrated, Internal antenna, Type C battery 1.5 - 3.6VDC, IP67, M12-M for sensor connection, M12-F for external power supply, RC1-RC6-RC7 zones

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.0

1.0.1

FEB-2020

1.0

1.0.1

08-MAY-2020

Updated correct file for CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-AI FW1.9.3.csv

2. Introduction

WSSFC-AI is the modular design Sigfox wireless sensor, based on 10-year experience in design and manufacturing Industrial sensor of Daviteq Company. It can accepts the analog output signal 0-20mA/0-10VDC from any sensor, transmitter...It can supplies the power to external sensor at 15VDC @ 50mA max. With Ultra-low power design and smart firmware allow the complete Wireless and Sensor package run on a Single battery C type up to 10 years. WSSFC-AI can support all regions of Sigfox network in over the World, RC1, RC2, RC3, RC4, RC5, RC6, RC7.

3. Specification

Input

01 x Analog input, 0 .. 20mA or 0..10VDC, selectable

Accuracy

0.05% of span

Resolution

1/3000

Temperature drift

< 50ppm

Power supply to sensor

15VDC @ max 50mA

Electrical connection

M12-M connector

Sigfox zones

select RC2-RC3-RC4-RC5 or RC1-RC6-RC7

Antenna

Fixed external Antenna 2.67 dbi

Battery

01 x C Type 1.5 - 3.6VDC, working time up to 10 years (depends on configuration), extendable by external battery box or power supply

RF Module complies to

CE, FCC, ARIB

Working temperature

-40oC..+85oC (using LS26500 battery)

Dimensions

H106xW73xD42 (Wireless part only)

Netweight

190 grams (Wireless part only)

Housing

Aluminum + Polycarbonate plastic, IP67

4. Product Pictures

5. Operation Principle

SIGFOX SENSOR WITH ANALOG INPUT WSSFC-AI has one port of analog can accept the DC current input from 0 - 20mA.

It can also provide the power supply to the external sensor or field instrument, the power supply is at 15VDC @ max 50mA.

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol).

After that, sigfox node will send the first message to Base station.

Then during the operation, there are 03 cases of sending data to base station:

When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE:Once sending the data to base station by this alarm event, the timer of sending time interval will be reset.

When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

By using the magnet key, the Sigfox node can be force to send data to base station immediately.

* Notes:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest duration between 02 times of magnet key activation should be larger than 15s (no downlink) or 60s (with downlink);

5.1 LED meaning

Whenever the data is sent to base station, the LED will lit with colour codes as below:

RC1: RED colour

RC2: GREEN colour

RC4: BLUE colour

5.2 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC3

RC4

RC5

RC6

RC7

Uplink center frequency (MHz)

868.130

902.200

923.200

920.800

923.300

865.200

868.800

Downlink center frequency (MHz)

869.525

905.200

922.200

922.300

922.300

866.300

869.100

Uplink data rate (bit/s)

100

600

100

600

100

100

100

Downlink data rate (bit/s)

600

600

600

600

600

600

600

Sigfox recommended EIRP (dBm)

16

24

16

24

14

16

16

Specifics

Duty cycle 1% *

Frequency hopping **

Listen Before Talk ***

Frequency hopping **

Listen Before Talk ***

Duty cycle 1% *

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

5.3 Process of measurement

When the sensor sampling time interval is reached, for example 2 minutes, the Sigfox node will wake up and switch ON the power supply to supply the energy to external sensor to start the measurement. Depends on the type and characteristic of external sensor, the sensor will take a certain time to finish the measurement and deliver the stable output of DC current.

For example, the measurement time is 500ms, after this time, the Analog input port of Sigfox node will read the value of DC current and then perform the calculation inside the micro-controller unit, with low cut and high cut performing Upon finished reading, Sigfox node will switch OFF power supply to external sensor to save energy. The shorter of measurement time, the more saving of energy of battery. The measurement time will be configured via offline Modbus configuration tool.

Once reading the analog value, the raw data is from 0 .. 4095 (unsigned integer), it can be scaled to any engineering value by the following formula:

Y = aX + b

Where:

X: the raw value (0..4095) from analog input port

Y: the calculated value will be sent to Sigfox base station in the payload data.

a: constant (default value is 1)

b: constant (default value is 0)

So, if there is no user setting for a and b ==> Y = X

The Y value will be compared with Lo and Hi threshold. Please refer below the graph of alarm processing.

​

5.4 Payload Data

The folllowing is the format of payload data will be sent to Sigfox server. Length is 6 bytes, it is future-proof for expansion to 12 bytes.

Sensor type (1 byte)

Status (1 byte)

1st - Parameter (4 bytes)

Meaning of Data in the Payload

Data

Size (byte)

Bit

Format

Meaning

Sensor type = 00000001

1

all

Uint8

- Sensor type = 00000001 means Sigfox node with analog 0-20mAdc input

Status: batt level

1

Bit 7 and 6

Uint8

Battery capacity in 04 levels 11: battery level 4 (99%) 10: battery level 3 (60%) 01: battery level 2 (30%) 00: battery level 1 (10%)The next - 2 bits : The next - 2 bits : b

Status: error

Bit 5 and 4

Node status 01: error 00: no error

Status: alarm 1

Bit 3 and 2

Alarm status of 1st - parameter (Y value) 11 : Hi alarm 01 : Lo alarm 00 : No alarm

Status: alarm 2

Bit 1 and 0

Spare for alarm status of 2nd - parameter

1st - Parameter

4

all

float

- Y value (calculated value of measurement)

6. Configuration

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reedswitch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE:the Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=BaX6RFlaEySKSYHX2j5nYHKBgeWckrox

How to use the Modbus configuration software

Step 2: Plug the configuration cable to computer via usb port and install the driver;

Step 3: Open the plastic housing;

Step 4: Plug the connector to the configuration port;

Step 5: Insert the battery;

Step 6:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-AI FW1.9.3.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-AI FW1.9.3.csv

Here is the table of Data will be read by Modbus tool

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

0

0

3

2

device info

string

Read

Product name

2

2

3

4

firmware version

1.0

string

Read

6

6

3

2

hardware version

1.0

string

Read

8

8

3

2

device ID

hex

Read

Product ID

10

A

3

4

device PAC

hex

Read

Product PAC

14

E

3

1

sen_type

1-255

uint16

Read

Sensor or Input Type

15

F

3

1

batt level

0-3

uint16

Read

Battery level

16

10

3

1

err_status

0-1

uint16

Read

Sensor error code

17

11

3

1

prm1 alm_status

0-2

uint16

Read

Alarm status of 1st parameter

18

12

3

1

prm2 alm_status

0-2

uint16

Read

Alarm status of 1st parameter

19

13

3

2

prm1 value

float

Read

1st calculated value

21

15

3

2

prm2 value

float

Read

2nd calculated value

23

17

3

1

batt %

10%, 30%, 60%, 99%

uint16

Read

Battery %

24

18

3

2

batt volt

0-3.67 vdc

float

Read

Battery Voltage

26

1A

3

2

temp

oC

float

Read

RF module temperature

28

1C

3

1

vref

0-3.67 vdc

uint16

Read

Vref of RF Module

29

1D

3

1

btn1 status

0-1

uint16

Read

Button status, 0: released, 1: pressed

30

1E

3

1

btn2 status

0-1

uint16

Read

Reedswitch status, 0: opened, 1: closed

Here is the table for Configuration:

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

256

100

3

16

1

modbus address

1-247

1

uint16

Read/

Write

Modbus address of device

257

101

3

16

1

modbus baudrate

0-1

0

uint16

Read/

Write

Baudrate: 0: 9600, 1: 19200

258

102

3

16

1

modbus parity

0-2

0

uint16

Read/

Write

Parity: 0: none, 1: odd, 2: even

259

103

3

16

9

serial number

string

Read/

Write

(PW)

Product S/N

268

10C

3

16

2

password for setting

uint32

Read/

Write

Password for setting

270

10E

3

16

1

Radio Configuration

1-6

4

uint16

Read/

Write

RC zones selection 1..6 is RCZ1 .. RCZ6

271

10F

3

16

1

tx_power

20

int16

Read/

Write

RF Tx power

272

110

3

16

1

tx_repeat

0-1

1

uint16

Read/

Write

Number of repeat, 0: 1 time, 1: 3 repeats

273

111

3

16

1

downlink_flag

0-1

0

uint16

Read/

Write

1: enable Downlink, 0: disable Downlink (Fw v1.0 hasn't got Downlink function)

274

112

3

16

2

cycle_send_data

900

uint32

Read/

Write

Data sending cycle, in seconds

276

114

3

16

2

spare

Spare for future

278

116

3

16

1

alarm_limit

44

uint16

Read/

Write

Limit number of alarm sending in 24h

279

117

3

16

1

spare

Spare for future

280

118

3

16

2

sensor1: sampling_rate

120

uint32

Read/

Write

Sensor/Input 1 sampling rate, in seconds

282

11A

3

16

2

sensor1: calc_time

100

uint32

Read/

Write

Measurement time of sensor/input 1, in ms

284

11C

3

16

2

sensor2: sampling_rate

120

uint32

Read/

Write

Sensor/Input 2 sampling rate, in seconds

286

11E

3

16

2

sensor2: calc_time

100

uint32

Read/

Write

Measurement time of sensor/input 2, in ms

288

120

3

16

2

prm1: a

1

float

Read/

Write

Constant a for scaling measured value 1

290

122

3

16

2

prm1: b

0

float

Read/

Write

Constant b for scaling measured value 1

292

124

3

16

2

prm1: Delta

-1

float

Read/

Write

Delta value for calculated value 1

294

126

3

16

2

prm1: High threshold

100000

float

Read/

Write

Hi Threshold for calculated value 1

296

128

3

16

2

prm1: High Hysteresis

10000

float

Read/

Write

Hysterisis for Hi for calculated value 1

298

12A

3

16

2

prm1: Low threshold

0

float

Read/

Write

Lo Threshold for calculated value 1

300

12C

3

16

2

prm1: Low Hysteresis

10000

float

Read/Write

Hysterisis for Lo for calculated value 1

302

12E

3

16

2

prm1: High cut

100000

float

Read/

Write

High cut value for calculated value 1

304

130

3

16

2

prm1: Low cut

0

float

Read/

Write

Low cut value for calculated value 1

306

132

3

16

2

prm2: a

1

float

Read/

Write

Constant a for scaling measured value 2

308

134

3

16

2

prm2: b

0

float

Read/

Write

Constant b for scaling measured value 2

310

136

3

16

2

prm2: Delta

-1

float

Read/

Write

Delta value for calculated value 2

312

138

3

16

2

prm2: High threshold

100000

float

Read/

Write

Hi Threshold for calculated value 2

314

13A

3

16

2

prm2: High Hysteresis

10000

float

Read/

Write

Hysterisis for Hi for calculated value 2

316

13C

3

16

2

prm2: Low threshold

0

float

Read/

Write

Lo Threshold for calculated value 2

318

13E

3

16

2

prm2: Low Hysteresis

10000

float

Read/

Write

Hysterisis for Lo for calculated value 2

320

140

3

16

2

prm2: High cut

100000

float

Read/

Write

High cut value for calculated value 2

322

142

3

16

2

prm2: Low cut

0

float

Read/

Write

Low cut value for calculated value 2

7. Installation

7.1 Mounting bracket installation

The mounting bracket is made from hard metallic material. Following to these steps as the below picture

7.2 Installation location

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicates with Station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because the RF signal can not pass through the metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

7.3 IO Wiring & Sensor installation

WSSFC-AI can use both Internal and External Power sources. When we plug in an External power source, WSSFC-AI will prioritize using external power. When the external power is disconnected, WSSFC-AI will use the Internal battery power.

WSSFC-AI has two M12 connectors : POWER and SENSOR .

7.3.1 POWER Connector

The POWER connector is an 3..3.6VDC external battery port, so if you want to use this port you must connect the POWER port to the POWER voltage converter cable as shown below.

The input power of the voltage converter cable is 12 ... 24VDC with DC jack and the output is 3.6VDC M12 Connector to connect with WSSFC-AI.

NOTE:Please do not supply the WSSFC-AI POWER port directly with 12 ... 24VDC without voltage converter cable.

7.3.2 SENSOR Connector

Connect the sensor to WSSFC-AI as shown below

For example: Connect the WSSFC-AI sensor to the Submersible Liquid Level Transmitter via M12 Connector

7.4 Power Supply & Battery installation

Steps for battery installation:

Step 1: Using L hex key to unscrew M4 screws at the side of housing

Step 2: Carefully pull out the top plastic housing in the vertical direction

Step 3: Insert the type C battery, please take note the poles of battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 4: Insert the top plastic housing and locking by L hex key

ATTENTION:When reinstalling the cover, pay attention to put the PCB edge into the middle slot of the box inside as shown below)

8. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

LED welding is not good

Check LED condition and LED weld

6

The value of the sensor is 0

Sensor connecting 4-20mA is loose

Check sensor connection

9. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

USER GUIDE FOR SIGFOX ULTRASONIC LEVEL SENSOR WSSFC-ULC

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC-ULC -MN-EN-01

DEC-2020

This document is applied for the following products

SKU

WSSFC-ULC

HW Ver.

1.1

FW Ver.

1.0

Item Code

WSSFC-ULC-9-01

Sigfox Ultrasonic Level Sensor for General Level/Distance Measurement, 30-600CMS, Internal antenna, Type AA battery 1.5VDC, IP68, RC2-RC4 zones

WSSFC-ULC-8-01

Sigfox Ultrasonic Level Sensor for General Level/Distance Measurement, 30-600CMS, Internal antenna, Type AA battery 1.5VDC, IP68, RC1 zones

0. Configuration Check List

STEP 1: Select RC

1. Select RC zone using Modbus Configuration Cable

RC zones selection 1, 2, 4 is RCZ1, RCZ2, RCZ4  (refer to register address 270)

2. Select RC zone using button

Refer to the button configuration

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section using the Modbus Configuration Cable

STEP 4:  Add device to Backend Sigfox

refer to section 5.4 for details

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.1

1.0

DEC-2020

2. Introduction

WSSFC-ULC is a Sigfox Ultrasonic Level Sensor to measure the level of liquid surface of water, oil... This level sensor utilises the ultrasonic technology to measure the surface of liquid, the principle is to measure the time of flight of the ultrasound pulse in the air environment. The ultrasound pulse will be ejected from ultrasonic transducer, go thru the air and reaching the surface of liquid, then reflected back to the ultrasonic transducer, the measuring circuit will measure the time of flight of the Pulse then calculate the distance from transducer to the surface. With Ultra-low Power design and smart firmware allow the sensor can last up to 10 years with 02 x AA-type batteries (depends on configuration). WSSFC-ULC can support all regions of Sigfox network in over the World, RC1, RC2, RC4.

3. Specification

Sensor SPECIFICATION:

Sensor

Ultrasonic sensor

Measurement range

280 .. 7500 mm

Resolution

±5.0mm

Accuracy

±10 mm + S*0.3% (with S is the measured value)

Sensor sampling rate

configurable from 10s up to 3600s

Alarm setting

setting the alarm threshold for calculated value

Sigfox SPECIFICATION:

Sigfox zones

select RC2-RC4 or RC1

Antenna

Internal Antenna 2dbi

Battery

02 x AA Type 1.5VDC, working time up to 10 years (depends on configuration)

RF Module complies to

CE, FCC, ARIB

Working temperature

-15°C..+60°C (with AA L91 Energizer)

Dimensions

H180xW50xD40

Net-weight

250 grams

Housing

Polycarbonate & POM plastic, IP68

4. Dimensions

5. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol).

After that, Sigfox node will send the first message to Base station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent.

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 15s. if shorter than 15s, there will be no data sending and you will not hear the beep sound.

5.1 LED meaning

Whenever the data is sent to base station, the LED will lit with color codes as below:

RC1: RED colour

RC2: GREEN colour

RC4: BLUE colour

5.2 Button Function

the push button can only be used for the first 60 seconds after powering up.

5.2.1 Menu configuration

There are 3 configuration menus: tx_repeat, downlink_flag, radio configuration.

We use the button to enter the menus as follows:

5.2.1.1 tx_repeat

Press and hold the button 2s  ->  When the Red LED is on, it means entering the tx_repeat configuration menu. Then release to configure it.

Press to configure. After pressing if the Red LED flashes once, tx_repeat = 0 (send 1 time). After pressing if the Red LED blinks twice, it is tx_repeat = 1 (send 3 times).

5.2.1.1 downlink_flag

Press and hold the button 5s  ->  When the Green LED is on, it means entering the downlink_flag configuration menu. Then release to configure it.

Press to configure. After pressing if the Green LED flashes once, it is downlink_flag = 0 (downlink is not allowed). After pressing if the Red LED blinks twice, it is downlink_flag = 1 (downlink is allowed).

5.2.1.1 radio configuration

Press and hold the button 10s  ->  Blue LED is on, it means entering the Radio Configuration menu. Then release to configure it.

Press to configure. After pressing if the Blue LED blinks once, it is Radio Configuration = 1. After pressing if the Blue LED flashes twice, it is Radio Configuration = 2. After pressing if the Blue LED flashes 4 times, it is Radio Configuration = 4.

5.2.2 Exit the menu:

There are 3 ways to exit the menu:

Press and hold for 3s, the LED turns off to exit the menu;

Wait 30 seconds, then exit the menu;

Take out the battery, it all starts over (outside the menu)).

5.3 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC4

Uplink center frequency (MHz)

868.130

902.200

920.800

Downlink center frequency (MHz)

869.525

905.200

922.300

Uplink data rate (bit/s)

100

600

600

Downlink data rate (bit/s)

600

600

600

Sigfox recommended EIRP (dBm)

16

24

24

Specifics

Duty cycle 1% *

Frequency hopping **

Frequency hopping **

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

5.4 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

5.5 The Effective Detection Range

5.6 Process of measurement

5.6.1 Measurement principle of Sigfox Sensor

When the sensor sampling time interval is reached, for example 2 minutes, the Sigfox node will wake up and switch ON the power supply to supply the energy to external sensor to start the measurement. Depends on the type and characteristic of external sensor, the sensor will take a certain time to finish the measurement.

Once reading the value, it can be scaled to any engineering value by the following formula:

Y = aX + b

Where:

X: the raw value from sensor

Y: the calculated value will be sent to Sigfox base station in the payload data.

a: constant (default value is 1)

b: constant (default value is 0)

So, if there is no user setting for a and b ==> Y = X

The Y value will be compared with Lo and Hi threshold. Please refer below the graph of alarm processing.

5.6.2 Calibration

Figure – Ultrasonic Level Transmitter Calibration

DB: Dead band 0..280 mm (This is a short range in front of the ultrasonic sensor can not measure distances)

H: Maximum measuring distance ( Span )

D: Distance

For example: Water tank with maximum height to be measured 3000mm (H) and Dead band (DB) is 280 mm, then:

From here we can look up the water level corresponding to the measured distance of the sensor by the formula: Y = aX + b.

Where: X is the measured distance (mm) and Y is the level (‰)

Distance (mm)

Level (‰)

280

1000

500

919

1000

735

1500

552

2000

368

2500

184

3000

0

Use the offline configuration tool to configure sigfox sensor. Write in the sensor the parameters a and b.

Refer to section 6 for more details.

5.7 Payload Data

The following is the format of payload data will be sent to Sigfox server. Length is 4 bytes.

Sensor type (1 byte)

Status (1 byte)

1 st - Parameter (2 bytes)

2nd - Parameter (2 bytes)

Meaning of Data in the Payload

Data

Size (byte)

Bit

Format

Meaning

Sensor type

1

all

Uint8

Sensor type = 0x0E means ULB_ULC sensor

Status: battery level

1

Bit 7 and 6

Uint8

Battery capacity in 04 levels

11: battery level 4 (99%)

10: battery level 3 (60%)

01: battery level 2 (30%)

00: battery level 1 (10%)

Status: error

Bit 5 and 4

Node status

01: error

00: no error

Status: alarm 1

Bit 3 and 2

Alarm status of 1st - Parameter (Y1 value)

11 : Hi alarm

01 : Lo alarm

00 : No alarm

Status: alarm 2

Bit 1 and 0

Alarm status of 2nd - Parameter (Y2 value)

11 : Hi alarm

01 : Lo alarm

00 : No alarm

1st - Parameter

2

all

Uint16

Y1 value: Level (x 0.1%)Y1 is calculated based on Y2 value by the formula:Y1 = Y2*a1+b1

2nd - parameter

2

all

Uint16

Y2 value: Distance(mm)

6. Offline configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=qK0PGNbY1g1fuxTqbFW9SXtEvCw7bpc6

How to use the Modbus configuration software

Step 2: Plug the configuration cable to Computer via USB port;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-ULC.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-ULC.csv

Here is the table of Data will be read by Modbus tool

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

0

0

3

2

device info

string

Read

Product name

2

2

3

4

firmware version

1.0

string

Read

6

6

3

2

hardware version

1.0

string

Read

8

8

3

2

device ID

hex

Read

Product ID

10

A

3

4

device PAC

hex

Read

Product PAC

14

E

3

1

sen_type

1-255

uint16

Read

Sensor or Input Type

15

F

3

1

batt level

0-3

uint16

Read

Battery level

16

10

3

1

err_status

0-1

uint16

Read

Sensor error code

17

11

3

1

prm1 alm_status

0-2

uint16

Read

Alarm status of 1st parameter

18

12

3

1

prm2 alm_status

0-2

uint16

Read

Alarm status of 1st parameter

19

13

3

2

prm1 value

float

Read

1st calculated value

21

15

3

2

prm2 value

float

Read

2nd calculated value

23

17

3

1

batt %

10%, 30%, 60%, 99%

uint16

Read

Battery %

24

18

3

2

batt volt

0-3.67 vdc

float

Read

Battery Voltage

26

1A

3

2

temp

oC

float

Read

RF module temperature

28

1C

3

1

vref

0-3.67 vdc

uint16

Read

Vref of RF Module

29

1D

3

1

btn1 status

0-1

uint16

Read

Button status, 0: released, 1: pressed

30

1E

3

1

btn2 status

0-1

uint16

Read

Reedswitch status, 0: opened, 1: closed

Here is the table for Configuration:

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

256

100

3

16

1

modbus address

1-247

1

uint16

Read/

Write

Modbus address of device

270

10E

3

16

1

Radio Configuration

1-6

4

uint16

Read/

Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

271

10F

3

16

1

tx_power

20

int16

Read/

Write

RF Tx power

272

110

3

16

1

tx_repeat

0-1

1

uint16

Read/

Write

Number of repeat, 0: 1 time, 1: 3 repeats

273

111

3

16

1

downlink_flag

0-1

1

uint16

Read/

Write

1: enable Downlink, 0: disable Downlink (Fw v1.0 hasn't got Downlink function)

274

112

3

16

2

cycle_send_data

3600

uint32

Read/

Write

Data sending cycle, in seconds

276

114

3

16

2

spare

Spare for future

278

116

3

16

1

alarm_limit

0

uint16

Read/

Write

Limit number of alarm sending in 24h

279

117

3

16

1

spare

Spare for future

280

118

3

16

2

sensor1: sampling_rate

120

uint32

Read/

Write

Sensor/Input 1 sampling rate, in seconds

282

11A

3

16

2

sensor1: calc_time

500

uint32

Read/

Write

Measurement time of sensor/input 1, in ms

288

120

3

16

2

prm1: a

1

float

Read/

Write

Constant a for scaling measured value 1

290

122

3

16

2

prm1: b

0

float

Read/

Write

Constant b for scaling measured value 1

294

126

3

16

2

prm1: High threshold

100000

float

Read/

Write

Hi Threshold for calculated value 1

296

128

3

16

2

prm1: High Hysteresis

10000

float

Read/

Write

Hysterisis for Hi for calculated value 1

298

12A

3

16

2

prm1: Low threshold

0

float

Read/

Write

Lo Threshold for calculated value 1

300

12C

3

16

2

prm1: Low Hysteresis

10000

float

Read/Write

Hysterisis for Lo for calculated value 1

302

12E

3

16

2

prm1: High cut

100000

float

Read/

Write

High cut value for calculated value 1

304

130

3

16

2

prm1: Low cut

0

float

Read/

Write

Low cut value for calculated value 1

306

132

3

16

2

prm2: a

1

float

Read/

Write

Constant a for scaling measured value 2

308

134

3

16

2

prm2: b

0

float

Read/

Write

Constant b for scaling measured value 2

312

138

3

16

2

prm2: High threshold

100000

float

Read/

Write

Hi Threshold for calculated value 2

314

13A

3

16

2

prm2: High Hysteresis

10000

float

Read/

Write

Hysterisis for Hi for calculated value 2

316

13C

3

16

2

prm2: Low threshold

0

float

Read/

Write

Lo Threshold for calculated value 2

318

13E

3

16

2

prm2: Low Hysteresis

10000

float

Read/

Write

Hysterisis for Lo for calculated value 2

320

140

3

16

2

prm2: High cut

100000

float

Read/

Write

High cut value for calculated value 2

322

142

3

16

2

prm2: Low cut

0

float

Read/

Write

Low cut value for calculated value 2

7. Installation

7.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

7.2 Process mounting

WARNINGS:1. Please make sure the fluid is suitable with the wetted materials of the sensor. Please refer sensor specification;2. Please make sure that the operating ambient temperature is right for the sensor. Please refer to the sensor's specifications;3. Prepare the professional tools for installation. The inappropriate tools may cause damage to the sensor.

7.2.1 Mounting direct on the tank

7.2.2 Mounting on wall or pole

7.3 Battery installation

ENERGIZER L91 (recommended battery)

Steps for battery installation:

Step 1: Using L hex key to unscrew M4 screws at the side of the housing and carefully pull out the top plastic housing in the vertical direction

Step 2: Insert 02 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing and locking by L hex key

ATTENTION:When reinstalling the cover, pay attention to put the PCB edge into the middle slot of the box inside as shown below)

8. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

LED welding is not good

Check LED condition and LED weld

6

The value of the sensor is 0

No pressure

Lost connection with the sensor

Check pipe pressure

Check sensor connection

7

The node does not send RF and the RF module is hot

Insert the battery in the opposite direction

Short circuit

Warranty or replacement

8

RSSI is weak and often loses data

Distance between Node and Gateway is far or there are many obstructions

Connection to Antenna problem

Check Antenna position

Install Node in a well ventilated location

9. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

USER GUIDE FOR EX D APPROVED SIGFOX READER FOR ELECTRONIC VOLUME CORRECTOR WSSFCEX-EVC

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFCEX-EVC -MN-EN-01

MAY-2021

This document is applied for the following products

SKU

WSSFCEX-EVC

HW Ver.

1.2

FW Ver.

1.2

Item Code

WSSFCEX-EVC-9-MINI-MAX-Z1

SIGFOX MERCURY EVC MINI-MAX READER, ATEX EXD APPROVAL ZONE 1/2, M20 CABLE GLAND WITH 10M SHIELDED CABLE AND AMP CONNECTOR, IP67 CAST ALUMINUM HOUSING, TYPE AA BATTERY 1.5VDC, RC2-RC3-RC4-RC5 ZONES

WSSFCEX-EVC-8-MINI-MAX-Z1

SIGFOX MERCURY EVC MINI-MAX READER, ATEX EXD APPROVAL ZONE 1/2, M20 CABLE GLAND WITH 10M SHIELDED CABLE AND AMP CONNECTOR, IP67 CAST ALUMINUM HOUSING, TYPE AA BATTERY 1.5VDC, RC1-RC6-RC7 ZONES

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.2

1.2

SEP-2020

2. Introduction

WSSFCEX-EVC is the Sigfox reader to read process data from Electronics Volume Corrector (EVC) with Exd approval for installation in Zone 1, Zone 2 or Safe Zone, and it can connect to any EVC with Modbus RTU communication or Mercury proprietary protocol. It will automatically read those parameters from EVC: corrected volume, un-corrected volume, gas pressure, gas temperature...With Ultra-low-power design and smart firmware allow the Sigfox device can last up to 10 years with single 2 x AA batteries (depends on configuration). It can supports all regions of Sigfox network in over the World, RC1, RC2, RC3, RC4, RC5, RC6, RC7. Typical applications are monitoring of Gas metering skids, Gas metering system for Natural Gas, LNG, CNG...

3. Specification

Type of EVC to connect

Connect to any Electronic Volume Corrector with Modbus RTU or Mercury protocol

Connector

Standard is AMP connector to work with Mercury Mini-Max EVC, for other EVC pls specify when ordering

Cable length

10m shielded cable

Sigfox zones

select RC2-RC3-RC4-RC5 or RC1-RC6-RC7

Antenna

N-male type external Antenna

Battery

02 x AA Type 1.5VDC, working time up to 10 years (depends on configuration)

ATEX Certificates

IMQ 14 ATEX 005 X and TÜV CY 18 ATEX 0206158 X

Marking

ATEX II 2G Ex db IIC T5/T6 Gb and ATEX II 2D Ex tb IIIC T100/T85°C Db

Directive

ATEX 2014/34/EU

Standards

IEC-EN60079-0 IEC-EN60079-1 IEC-EN60079-31

Applicable zones

Zone 1 - 21 (gas) and Zone 2 - 22 (dust)

Ambient working temperature

-40°C..+85°C

Housing

Cast aluminium, powder coated, IP66

Mounting

wall mounting holes

Product dimensions

H210xW100XD72

Net weight

1.5 kgs

Packaging dimension

W160 x D150 x H250 mm

Gross weight

< 1.6 kgs

4. Dimensions

5. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol).

After that, Sigfox node will send the first message to Base station.

Then during the operation, there are 03 cases of sending data to base station:

When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent.

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 15s. if shorter than 15s, there will be no data sending and you will not hear the beep sound.

5.1 LED meaning

Whenever the data is sent to base station, the LED will lit with color codes as below:

RC1: RED colour

RC2: GREEN colour

RC4: BLUE colour

5.2 Button Function

5.2.1 Menu configuration

There are 3 configuration menus: tx_repeat, downlink_flag, radio configuration.

We use the button to enter the menus as follows:

5.2.1.1 tx_repeat

Press and hold the button 2s  ->  When the Red LED is on, it means entering the tx_repeat configuration menu. Then release to configure it.

Press to configure. After pressing if the Red LED flashes once, tx_repeat = 0 (send 1 time). After pressing if the Red LED blinks twice, it is tx_repeat = 1 (send 3 times).

5.2.1.1 downlink_flag

Press and hold the button 5s  ->  When the Green LED is on, it means entering the downlink_flag configuration menu. Then release to configure it.

Press to configure. After pressing if the Green LED flashes once, it is downlink_flag = 0 (downlink is not allowed). After pressing if the Red LED blinks twice, it is downlink_flag = 1 (downlink is allowed).

5.2.1.1 radio configuration

Press and hold the button 10s  ->  Blue LED is on, it means entering the Radio Configuration menu. Then release to configure it.

Press to configure. After pressing if the Blue LED blinks once, it is Radio Configuration = 1. After pressing if the Blue LED flashes twice, it is Radio Configuration = 2. After pressing if the Blue LED flashes 4 times, it is Radio Configuration = 4.

5.2.2 Exit the menu:

There are 3 ways to exit the menu:

Press and hold for 3s, the LED turns off to exit the menu;

Wait 30 seconds, then exit the menu;

Take out the battery, it all starts over (outside the menu)).

5.3 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC3

RC4

RC5

RC6

RC7

Uplink center frequency (MHz)

868.130

902.200

923.200

920.800

923.300

865.200

868.800

Downlink center frequency (MHz)

869.525

905.200

922.200

922.300

922.300

866.300

869.100

Uplink data rate (bit/s)

100

600

100

600

100

100

100

Downlink data rate (bit/s)

600

600

600

600

600

600

600

Sigfox recommended EIRP (dBm)

16

24

16

24

14

16

16

Specifics

Duty cycle 1% *

Frequency hopping **

Listen Before Talk ***

Frequency hopping **

Listen Before Talk ***

Duty cycle 1% *

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication​

5.4 Payload Data

The following is the format of payload data will be sent to Sigfox server.

5.4.1 Payload data 12 bytes sent hourly

Sensor type (1 byte)

Status + Interval Avg Pressure + Interval Avg Temperature (3 bytes)

Corrected Volume (4 bytes)

Uncorrected Volume (4 bytes)

Meaning of Data in the Payload

Data

Size

Bit

Format

Meaning

Sensor type

1 byte

all

Uint8

Sensor type = 0x16 means Sigfox Node with EVC sensor type = 0xFF means no sensor.

Status: battery level

2 bits

Bit 23 and 22

Battery capacity in 04 levels

11: battery level 4 (99%)

10: battery level 3 (60%)

01: battery level 2 (30%)

00: battery level 1 (10%)

Status: error

2 bits

Bit 21 and 20

Node status

01: error

00: no error

Interval Avg Pressure (bar)

10 bits

Bit 19 to 10

Uint16

X Real Interval Avg Pressure value = X Interval Avg Pressure value / 10

(0.0 to 102.3bar)

Interval Avg Temperature (℃)

10 bits

Bit 9 to 0

Uint16

Y Real Interval Avg Temperature value = Y Interval Avg Temperature value / 10

(0.0 to 102.3℃ )

Corrected Volume(m3)

4 bytes

all

Uint32

Corrected Volume

Uncorrected Volume(m3)

4 bytes

all

Uint32

Uncorrected Volume

FOR EXAMPLE

Raw data: 0x16819FF60156C78600238415

Explain:

Sesor type : 0x16

Status + Interval Avg Pressure + Interval Avg Temperature : 0x819FF6 = 0b100000011001111111110110

Status battery level : 0b10 battery level 3 (60%)

Status error : 0b00 Node status no error

Interval Avg Pressure : 0b0001100111 = 103 => Interval Avg Pressure = 10.3 (bar)

Interval Avg Temperature : 0b1111110110 = 1014 => Interval Avg Temperature = 101.4 (℃)

Corrected Volume : 0x0156C786 = 22464390

Uncorrected Volume : 0x00238415 = 02327573

5.4.2 Payload battery packet sent daily 4 bytes

Sensor type (1 byte)

Status (1 byte)

Battery Voltage  (2 bytes)

Meaning of Data in the Payload

Data 

Size 

Bit

Format

Meaning

Sensor type

1 byte

all

Uint8

Sensor type = 0x16 means Sigfox Node with EVC sensor type = 0xFF means no sensor.

Status: battery level

2 bits

Bit 7 and 6

Battery capacity in 04 levels

11: battery level 4 (99%)

10: battery level 3 (60%)

01: battery level 2 (30%)

00: battery level 1 (10%)

Status: error

2 bits

Bit 5 and 4

Node status

01: error

00: no error

Status : reserved

4 bits

Bit 3 to 0

0000

Battery Voltage (V)

2 bytes

all

Uint16

X Real Battery Voltage of EVC = X Real Battery Voltage of EVC / 100

FOR EXAMPLE

Raw data: 0x16800252

Explain:

Sesor type : 0x16

Status : 0x80 = 0b10000000

Status battery level : 0b10 battery level 3 (60%)

Status error : 0b00 Node status no error

Status reserved : 0000

Battery Voltage : 0x0252 = 594 => Battery Voltage = 5.94 (V)

5.4.3 Payload for downlink

Length is 8 bytes

Prm_adr (1 byte)

Prm_len (1 byte)

Prm_value (6 bytes)

Prm_name

Prm_adr

Prm_len

Comment

cycle_send_data

18

4

6. Configuration

DANGER:DO NOT OPEN THE COVER AT HAZARDOUS LOCATION!ONLY OPEN COVER FOR TROUBLE SHOOTING AND CONFIGURATION IN SAFE AREA!

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=qK0PGNbY1g1fuxTqbFW9SXtEvCw7bpc6

How to use the Modbus configuration software

Step 2: Plug the configuration cable to computer via USB port and install the driver;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Red

Tx

Black

Rx

Yellow

GND

Tx on cable will go with Rx on sensor and vice versa.

Step 5: Insert the battery;

ATTENTION: REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 6:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX FW1.9.3.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFCEX-EVC.csv

Here is the table of Data will be read by Modbus tool

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

0

0

3

2

device info

string

Read

Product name

2

2

3

4

firmware version

1.0

string

Read

6

6

3

2

hardware version

1.0

string

Read

8

8

3

2

device ID

hex

Read

Product ID

10

A

3

4

device PAC

hex

Read

Product PAC

14

E

3

1

sen_type

1-255

uint16

Read

Sensor or Input Type

15

F

3

1

batt level

0-3

uint16

Read

Battery level

16

10

3

1

err_status

0-1

uint16

Read

Sensor error code

17

11

3

1

prm1 alm_status

0-2

uint16

Read

Alarm status of 1st parameter

18

12

3

1

prm2 alm_status

0-2

uint16

Read

Alarm status of 1st parameter

19

13

3

2

prm1 value

float

Read

1st calculated value

21

15

3

2

prm2 value

float

Read

2nd calculated value

23

17

3

1

batt %

10%, 30%, 60%, 99%

uint16

Read

Battery %

24

18

3

2

batt volt

0-3.67 vdc

float

Read

Battery Voltage

26

1A

3

2

temp

oC

float

Read

RF module temperature

28

1C

3

1

vref

0-3.67 vdc

uint16

Read

Vref of RF Module

29

1D

3

1

btn1 status

0-1

uint16

Read

Button status, 0: released, 1: pressed

30

1E

3

1

btn2 status

0-1

uint16

Read

Reedswitch status, 0: opened, 1: closed

Here is the table for Configuration:

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

256

100

3

16

1

modbus address

1-247

1

uint16

Read/

Write

Modbus address of device

257

101

3

16

1

modbus baudrate

0-1

0

uint16

Read/

Write

Baudrate: 0: 9600, 1: 19200

258

102

3

16

1

modbus parity

0-2

0

uint16

Read/

Write

Parity: 0: none, 1: odd, 2: even

259

103

3

16

9

serial number

string

Read/

Write

(PW)

Product S/N

268

10C

3

16

2

password for setting

uint32

Read/

Write

Password for setting

270

10E

3

16

1

Radio Configuration

1-6

4

uint16

Read/

Write

RC zones selection 1..6 is RCZ1 .. RCZ6

271

10F

3

16

1

tx_power

20

int16

Read/

Write

RF Tx power

272

110

3

16

1

tx_repeat

0-1

1

uint16

Read/

Write

Number of repeat, 0: 1 time, 1: 3 repeats

273

111

3

16

1

downlink_flag

0-1

0

uint16

Read/

Write

1: enable Downlink, 0: disable Downlink (Fw v1.0 hasn't got Downlink function)

274

112

3

16

2

cycle_send_data

3600

uint32

Read/

Write

Data sending cycle, in seconds

7. Installation

7.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

WARNINGS:Prepare the professional tools for installation. The inappropriate tools may cause damage to the sensor.

DANGER:1. The installer need to be equipped with full Safety gears during installation, such as safety glasses, safety shoes, safety cloths, safety mask...Please follow the safety instructions of the installation site;2. The installer must be qualified for this installation job;3. The installer must be permitted by Site's owner for performing the installation;4. The working conditions in hazardous areas (toxic gases, explosive atmosphere, high pressure, high temperature...) must be highly attention and follow the site's owner instruction strictly.DO NOT OPEN THE COVER OR REPLACE/INSERT BATTERIES IN THE HAZADOUS AREAS

7.2 Battery installation

Steps for battery installation:

DANGER:DO NOT REPLACE BATTERY AT HAZARDOUS LOCATION!DO NOT OPEN THE COVER AT HAZARDOUS LOCATION!ONLY OPEN COVER AND REPLACE BATTERY IN SAFE AREA!

Step 1: Turn the front cover of the sensor counter-clockwise;

Step 2: Carefully take out the front cover of the sensor

Step 3: Insert the type AA battery, please take note the polarity of battery

ATTENTION: REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 4: Turn the front cover of the sensor clockwise to close fully.

NOTES: Using 2mm hex key to lock the cover to prevent the unattended opening.

7.3 Sigfox node connection

WSSFCEX-EVC can connect to any electronic volume corrector via Mercury protocol.

Configuration information for EVC

RS232 Connection: auto-baurate or 9600

Instrument access code: 33333

Temperature Unit: °C

Model requirements: Honeywell / Mercury Mini - Max

8. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

LED welding is not good

Check LED condition and LED weld

6

The value of the sensor is 0

No pressure

Lost connection with the sensor

Check pipe pressure

Check sensor connection

7

The node does not send RF and the RF module is hot

Insert the battery in the opposite direction

Short circuit

Warranty or replacement

8

RSSI is weak and often loses data

Distance between Node and Gateway is far or there are many obstructions

Connection to Antenna problem

Check Antenna position

Install Node in a well ventilated location

9. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

USER GUIDE FOR EX D APPROVED SIGFOX PROCESS PRESSURE SENSOR WSSFCEX-PPS

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFCEX-PPS -MN-EN-01

SEP-2020

This document is applied for the following products

SKU

WSSFCEX-PPS

HW Ver.

1.2

FW Ver.

1.2

Item Code

WSSFCEX-PPS-9-10

SIGFOX GAGE PROCESS PRESSURE SENSOR, ATEX EXD APPROVAL ZONE 1/2, RANGE 0-10 BARG, ACCURACY 0.5%, PROCESS CONNECTION 1/2" NPT-MALE, 316SS, TYPE AA BATTERY 1.5VDC, RC2-RC3-RC4-RC5 ZONES

WSSFCEX-PPS-8-10

SIGFOX GAGE PROCESS PRESSURE SENSOR, ATEX EXD APPROVAL ZONE 1/2, RANGE 0-10 BARG, ACCURACY 0.5%, PROCESS CONNECTION 1/2" NPT-MALE, 316SS, TYPE AA BATTERY 1.5VDC, RC1-RC6-RC7 ZONES

WSSFCEX-PPS-G-1000

SIGFOX GAGE PROCESS PRESSURE SENSOR, ATEX EXD APPROVAL ZONE 1/2, RANGE 0-1000 BARG, ACCURACY 0.5%, PROCESS CONNECTION 1/2"NPT-MALE, 316LSS, TYPE AA BATTERY 1.5VDC, RC1-RC2-RC3-RC4 ZONES

0. Configuration Check List

STEP 1: Select RC

1. Select RC zone

RC zones selection 1, 2, 4,... is RCZ1, RCZ2, RCZ4,...  (refer to section 6)

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section 5 and section 6

STEP 4:  Add device to Backend Sigfox

refer to section 5.2 for details

STEP 5:  Installation

refer to section 7  for details

1. Change Log

Document Ver.

Release Date

Change log

1.0

SEP-2020

- First version for WSSFCEX-PPS

1.1

FEB-2022

- Update information of WSSFCEX-PPS-G-1000

2. Introduction

WSSFCEX-PPS is the Sigfox Integrated Process Pressure Sensor with Exd approval for installation in Zone 1, Zone 2 or Safe Zone, and it has different kinds of measurements, such as Gage/Absolute/Sealed Gage, range -1 .. + 700 bar, high accuracy, and stability. With Ultra-low-power design and smart firmware allow the sensor can last up to 10 years with single C battery (depends on configuration). It can supports all regions of Sigfox network in over the World, RC1, RC2, RC3, RC4, RC5, RC6, RC7. Typical applications are pressure monitoring of oil pipeline, gas pipeline, LPG tank, CNG tank, etc.

3. Specification

Sensor

Advanced PIEZO technology

Measurement range

Select from -1 .. + 1000 bar Gage/Absolute/Sealed Gage

Over pressure protection

1.5 x Span

Accuracy & Stability

0.5% of span, < 0.3% span/year

Wetted parts & Measuring Fluids

304SS/316SS, Any fluid which is workable with materials 304SS/316SS

Fluid Working temperature

0 .. + 80 oC

Process connection

1/2” NPT-male as standard, others please consult factory

Sigfox zones

select RC2-RC3-RC4-RC5 or RC1-RC6-RC7

Antenna

N-male type external Antenna

Battery

02 x AA Type 1.5VDC as standard, working time up to 10 years (depends on configuration). 02 x Battery AA 3.6V is also available as optional.

ATEX Certificates

IMQ 14 ATEX 005 X, TÜV CY 18 ATEX 0206158 X and IECEx DEK 15.0048X

Marking

ATEX II 2G Ex db IIC T5/T6 Gb and ATEX II 2D Ex tb IIIC T100/T85°C Db

Directive

ATEX 2014/34/EU

Standards

IEC-EN60079-0 IEC-EN60079-1 IEC-EN60079-31

Applicable zones

Zone 1 - 21 (gas) and Zone 2 - 22 (dust)

Ambient working temperature

-40oC..+85oC

Housing

Cast aluminium, powder coated, IP66

Mounting

wall mounting holes

Product dimensions

H100xW100xD80 (excluded antenna)

Net weight

1.5 kgs

Packaging dimension

W160 x D150 x H250 mm

Gross weight

< 1.6 kgs

4. Dimensions

4.1 WSSFCEX-PPS with 0-10 barg version

5. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol)

After 1 minute 30 seconds later the device will send the first data packet and at the same time wait for the downlink packet from the Base Station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent. (Buzzer will be updated in the latest version)

EVENT

PRE-CONDITION

ACTION

LED STATUS

BUZZER STATUS

ACTIVITIES

POST-CONDITION

FORCE_DATA

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beep 1 time, move Magnet Key away.

Blink SKY BLUE

Beep 1 time

See FW specs

Back to previous state

PARAMETERS_UPDATE

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beep 1 time, hold Magnet Key 5s.Buzzer beep 2 times.

Blink PURPLE

Beep 2 times

See FW specs

Back to previous state

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 15s. if shorter than 15s, there will be no data sending.

5.1 LED meaning

Whenever the data is sent to base station, the LED will lit with color codes as below:

RC1: RED colour

RC2: GREEN colour

RC4: BLUE colour

5.2 Button Function

5.2.1 Menu configuration

There are 3 configuration menus: tx_repeat, downlink_flag, radio configuration.

We use the button to enter the menus as follows:

5.2.1.1 tx_repeat

Press and hold the button 2s  ->  When the Red LED is on, it means entering the tx_repeat configuration menu. Then release to configure it.

Press to configure. After pressing if the Red LED flashes once, tx_repeat = 0 (send 1 time). After pressing if the Red LED blinks twice, it is tx_repeat = 1 (send 3 times).

5.2.1.1 downlink_flag

Press and hold the button 5s  ->  When the Green LED is on, it means entering the downlink_flag configuration menu. Then release to configure it.

Press to configure. After pressing if the Green LED flashes once, it is downlink_flag = 0 (downlink is not allowed). After pressing if the Red LED blinks twice, it is downlink_flag = 1 (downlink is allowed).

5.2.1.1 radio configuration

Press and hold the button 10s  ->  Blue LED is on, it means entering the Radio Configuration menu. Then release to configure it.

Press to configure. After pressing if the Blue LED blinks once, it is Radio Configuration = 1. After pressing if the Blue LED flashes twice, it is Radio Configuration = 2. After pressing if the Blue LED flashes 4 times, it is Radio Configuration = 4.

5.2.2 Exit the menu:

There are 3 ways to exit the menu:

Press and hold for 3s, the LED turns off to exit the menu;

Wait 30 seconds, then exit the menu;

Take out the battery, it all starts over (outside the menu)).

5.3 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC4

Uplink center frequency (MHz)

868.130

902.200

920.800

Downlink center frequency (MHz)

869.525

905.200

922.300

Uplink data rate (bit/s)

100

600

600

Downlink data rate (bit/s)

600

600

600

Sigfox recommended EIRP (dBm)

16

24

24

Specifics

Duty cycle 1% *

Frequency hopping **

Frequency hopping **

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

5.4 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

5.5 Process of measurement

When the sensor sampling time interval is reached, for example 2 minutes, the Sigfox node will wake up and switch ON the power supply to supply the energy to external sensor to start the measurement. Depends on the type and characteristic of external sensor, the sensor will take a certain time to finish the measurement.

Once reading the value, it can be scaled to any engineering value by the following formula:

Y = aX + b

Where:

X: the raw value from sensor

Y: the calculated value will be sent to Sigfox base station in the payload data.

a: constant (default value is 1)

b: constant (default value is 0)

So, if there is no user setting for a and b ==> Y = X

The Y value will be compared with Lo and Hi threshold. Please refer below the graph of alarm processing.

​

5.6 Configuration Parameters

Parameter

Description

Possible values

Default value 

Length (in bits)

HIGH_ALARM_SETPOINT

High alarm setpoint for calculated value

32-bit float

1000000000

32

LOW_ALARM_SETPOINT_FACTOR

Low alarm setpoint for calculated value

8-bit unsigned integerLOW_ALARM_SETPOINT = HIGH_ALARM_SETPOINT *  LOW_ALARM_SETPOINT_FACTOR / 200

0

8

ALARM_ENABLE

Enable/Disable ALARM event

0b0 = ALARM event is OFF0b1 = ALARM event is ON

0b0 = ALARM event is OFF

1

ALARM_PERIOD

Period of time to send ALARM event

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b000 = every  10min

3

LED_BUZZER_ENABLE

Enable/Disable LEDs and Buzzersinteractions for action not triggered by the reed switch

0b1 = LEDs and Buzzers are ON

1

HEARTBEAT_PERIOD

Period of time to send HEARTBEAT event

0b000 = every  1h0b001 = every  6h0b010 = every 12h0b011 = every 24h (1 day)0b100 = every 48h (2 days)0b101 = every 72h (3 days)0b110 = every 120h (5 days)0b111 = every 240h (10 days)

0b011 = every 24h (1 day)

3

MEASURE_PERIOD

Period of time to measuresensor

0b0000 = every 1s0b0001 = every 2s0b0010 = every 5s0b0011 = every 10s0b0100 = every 20s0b0101 = every 30s0b0110 = every 1min0b0111 = every 2min0b1000 = every 5min0b1001 = every 10min0b1010 = every 20min0b1011 = every 30min0b1100 = every 1h0b1101 = every 2h0b1110 = every 3h0b1111 = every 6h

0b1001 = every 10min

4

TX_REPEAT

Sigfox TX repeat

0b0 = Send RF 1 time0b1 = Send RF 3 time

0b1 = Send RF 3 time

1

CYCLIC_DATA_PERIOD

Period of time to send CYCLIC_DATA event

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b001 = every  30min

3

DEVICE_RESET

Once this parameter is set, the device shall restart once after having received the Downlink.

0b1010 = 0xA = force device resetothers = do nothing

0b0000 = do nothing

4

DOWNLINK_TYPE

Downlink type

4-bit unsigned integerSee Sigfox Downlink tab

0b0000

4

5.7 Payload Data

The following is the format of payload data will be sent to Sigfox server. Length is 6 bytes, it is future-proof for expansion to 12 bytes.

5.7.1 Payload Fields

Data name

Description

Encoding or Possible values

Length (in bits)

EVENT_ID

Unique ID identifying the device event

4-bit unsigned integer0 = START_UP1 = HEARTBEAT2 = PARAMETERS_UPDATE3 = FORCE_DATA4 = CYCLIC_DATA5 = ALARM

4

HW_VERSION

Indicate HW  version

4-bit unsigned integer1..15

4

FW_VERSION

Indicate FW version

8-bit unsigned integer1..255

8

LATEST_SIGFOX_DOWNLINK

Latest received and valid sigfox downlink frame= Current configuration

64-bit encoded fieldSee Sigfox Downlink tab

64

HW_ERROR

HW error

0b0 = no error0b1 = error

1

ALARM

Alarm

0b00 = no alarm0b01 = low alarm0b10 = high alarm0b11 = not used

2

BATTERY_LEVEL

Battery level

2-bit unsigned integer0..3

2

RAW_VALUE

Raw value of pressure sensor (12-bit)

16-bit unsigned integer

16

PRESSURE

Scaled value of pressure sensor

32-bit float

32

TENTATIVE

Tentative number

8-bit unsigned integerFormula: (8-bit_Tentative +1)= real_tentative #Range: 1 to 256Accuracy: 1Example: 0b00000111 = 0x7=7=> 7+1 =>tentative # 8

8

5.7.2 Sigfox Uplink Frame Format

Size

START_UP

(led blink WHITE)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

 10.0

bits

4

4

8

64

Value

0b0000 = 0

yes

yes

yes

HEARTBEAT

(led blink GREEN)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

 10.0

bits

4

4

8

64

Value

0b0001 = 1

yes

yes

yes

PARAMETERS_UPDATE

(led blink PURPLE)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

 10.0

bits

4

4

8

64

Value

0b0010 = 2

yes

yes

yes

FORCE_DATA

(led blink SKY BLUE)

Payload

EVENT_ID

HW_ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

PRESSURE

 8.0

bits

4

1

3

2

2

4

16

32

Value

0b0011 = 3

yes

zeros

yes

yes

zeros

yes

yes

CYCLIC_DATA

(led blink SKY BLUE)

Payload

EVENT_ID

HW_ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

PRESSURE

 9.0

bits

4

1

3

2

2

4

16

32

Value

0b0100 = 4

yes

zeros

yes

yes

zeros

yes

yes

ALARM

(led blink RED)

Payload

EVENT_ID

HW_ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

PRESSURE

 9.0

bits

4

1

3

2

2

4

16

32

Value

0b0101 = 5

yes

zeros

yes

yes

zeros

yes

yes

5.7.3 Payload for Downlink, length is 8 bytes.

The Sigfox node is only able to receive max 04 downlinks a day, each downlink will be waiting in every 06 hours.

User can set the down link data in Sigfox back-end system in advance, whenever the Sigfox node connected to base stations and with downlink waiting is enable at that time (one time in 6 hours), the downlink data will be loaded to Sigfox node.

The downlink data can be any configuration parameter.

Please pay attention when send downlink data. If there was a mistake in sending wrong data, it would cause the Sigfox node not working properly and user need to configure it by offline cable!!!

Size

DOWNLINK_TYPE = 0

Payload

HIGH_ALARM_SETPOINT

LOW_ALARM_SETPOINT_FACTOR

ALARM_ENABLE

ALARM_PERIOD

LED_BUZZER_ENABLE

HEARTBEAT_PERIOD

 8.0

bits

32

8

1

3

1

3

Value

yes

yes

yes

yes

yes

yes

MEASURE_PERIOD

TX_REPEAT

CYCLIC_DATA_PERIOD

DEVICE_RESET

DOWNLINK_TYPE

4

1

3

4

4

yes

yes

yes

yes

0b0000 = 0

Size

DOWNLINK_TYPE = 5

Payload

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

reserved

DOWNLINK_TYPE

 8.0

bits

8

8

16

28

4

Value

yes

0x02 = 2

yes

zeros

0b0101 = 5

Payload

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

reserved

DOWNLINK_TYPE

 8.0

bits

8

8

32

12

4

Value

yes

0x04 = 4

yes

zeros

0b0101 = 5

6. Configuration

DANGER:DO NOT OPEN THE COVER AT HAZARDOUS LOCATION!ONLY OPEN COVER FOR TROUBLE SHOOTING AND CONFIGURATION IN SAFE AREA!

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=qK0PGNbY1g1fuxTqbFW9SXtEvCw7bpc6

How to use the Modbus configuration software

Step 2: Plug the configuration cable to computer via USB port and install the driver;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Red

Tx

Black

Rx

Yellow

GND

Tx on cable will go with Rx on sensor and vice versa.

Step 5: Insert the battery;

Step 6:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX FW1.9.3.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFCEX-PPS.csv

Here is the table of Data will be read by Modbus tool

Modbus Register (DEC)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Here is the table for Configuration:

Modbus Register (DEC)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

274

112

3

16

1

SERVER_CONFIG

uint16

Read/Write

0: Send to Sigfox Network1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1, 2, 4

4

uint16

Read/Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

0

float

Read/Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1000000000

float

Read/Write

High cut value for calculated value

284

11C

3

16

2

LOW_CUT

-1000000000

float

Read/Write

Low cut value for calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

200

uint32

Read/Write

Boot time of sensor/input, in ms

7. Installation

7.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

7.2 Process mounting

WARNINGS:1. Please make sure the fluid is suitable with the wetted materials of the sensor. Please refer sensor specification;2. Please make sure the operating temperature and pressure is suitable with the sensor. Please refer sensor specification;3. Prepare the professional tools for installation. The inappropriate tools may cause damage to the sensor.

DANGER:1. The installer need to be equipped with full Safety gears during installation, such as safety glasses, safety shoes, safety cloths, safety mask...Please follow the safety instructions of the installation site;2. The installer must be qualified for this installation job;3. The installer must be permitted by Site's owner for performing the installation;4. The working conditions in hazardous areas (toxic gases, explosive atmosphere, high pressure, high temperature...) must be highly attention and follow the site's owner instruction strictly.DO NOT OPEN THE COVER OR REPLACE/INSERT BATTERIES IN THE HAZADOUS AREAS

Consider to use the isolation valve 1/2" or 1/4" to isolate the media and the sensor during maintenance;

Fully closing the isolation valve during installation and maintenance the sensor;

Fully open the isolation valve during normal operation;

There are two ways of process mounting as below.

7.2.1 Mounting direct on Pipe

The total weight of the sensor MUST be within the permitted load of the pipe to be installed;

Consider to build the support for the pipe if the sensor weight is larger than the permit;

Below picture shown without the isolation valve, but we highly recommend to use isolation valve.

7.2.2 Remote mounting on wall or pole

Make sure the wall or place of pole for mounting is not covered or affected by the surrounding metallic objects;

Using the metal tubing and fittings for interconnection between process pipe and sensor process connector;

The metal tubing and fitting materials, and size must be sizing properly to suit the process conditions;

It is better to install the isolation valve next to sensor process connector.

7.3 Battery installation

Steps for battery installation:

DANGER:DO NOT REPLACE BATTERY AT HAZARDOUS LOCATION!DO NOT OPEN THE COVER AT HAZARDOUS LOCATION!ONLY OPEN COVER AND REPLACE BATTERY IN SAFE AREA!

Step 1: Turn the front cover of the sensor counter-clockwise;

Step 2: Carefully take out the front cover of the sensor

Step 3: Insert the type AA battery, please take note the polarity of battery

ATTENTION: REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 4: Turn the front cover of the sensor clockwise to close fully.

NOTES: Using 2mm hex key to lock the cover to prevent the unattended opening.

8. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

LED welding is not good

Check LED condition and LED weld

6

The value of the sensor is 0

No pressure

Lost connection with the sensor

Check pipe pressure

Check sensor connection

7

The node does not send RF and the RF module is hot

Insert the battery in the opposite direction

Short circuit

Warranty or replacement

8

RSSI is weak and often loses data

Distance between Node and Gateway is far or there are many obstructions

Connection to Antenna problem

Check Antenna position

Install Node in a well ventilated location

9. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

USER GUIDE FOR SIGFOX-READY AMMONIA GAS SENSOR WITH BLE WSSFCB-NH3

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC- NH3-MN-EN-01

AUG-2021

This document is applied for the following products

SKU

WSSFCB-NH3

HW Ver.

1.1

FW Ver.

1.0

Item Code

WSSFCB-NH3-8-01

Wireless Sigfox Ammonia Gas Sensor with BLE, Internal antenna, Type AA battery 1.5VDC, IP67, RC1 zone

WSSFCB-NH3-9-01

Wireless Sigfox Ammonia Gas Sensor with BLE, Internal antenna, Type AA battery 1.5VDC, IP67, RC2-RC4 zones

0. Configuration Check List

STEP 1: Select RC

1. Select RC zone

RC zones selection 1, 2, 4,... is RCZ1, RCZ2, RCZ4,...  (refer to section 6)

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section 5

STEP 4:  Add device to Backend Sigfox

refer to section 5.2 for details

STEP 5:  Installation

refer to section 8  for details

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.1

1.0

DEC-2020

2. Introduction

WSSFC-NH3 is a Sigfox-ready electrochemical-type gas sensor which has high sensitivity to low concentrations of ammonia gas, high selectivity, and a stable baseline. Integrated ambient humidity and temperature so the sensor can be measured by special algorithm expertise through modelling and compensating of external heat sources without the need of any additional components. With Ultra-low power design and smart firmware allow the complete Wireless and Sensor package run on 1 x AA battery 3.6V for 2-5 years with 15 minutes update. It can support all regions of Sigfox network in over the World, RC1, RC2, & RC4.

Typical Applications: Monitor leakage of Ammonia gas for Refrigerator, monitor Ammonia in private or public toilets,...

3. Specification

SENSORS SPECIFICATION:

NH3 sensor

electrochemical-type gas sensor

Measuring range for NH3

0..100 ppm

Max detecting concentration

200 ppm

Repeatability / Resolution / Stability per month

< 10% of Reading value / 1 ppm / < 2% of Reading value

Zero stability

+/- 2 ppm

Working atmospheric pressure

101.3 Kpa +/- 10%

Sensor life

> 2 years

Humidity and Temperature sensor

Digital type, factory calibrated

Humidity measuring range / accuracy / resolution

0 .. 100 %RH, ± 2.0% / 0.1%

Temperature measuring range / accuracy / resolution

-40 .. + 85°C / ± 0.2°C / 0.1°C

Working temperature and humidity

-30 .. + 50°C, 15 .. 90% RH

Sensor housing / Rating

SS316/SS304 housing with 316SS sintered filter / for Indoor use

Sigfox SPECIFICATION:

Sigfox zones

select RC1-RC2-RC4

Antenna

Internal Antenna 2dbi

Battery

02 x AA Type 1.5VDC, working time up to 10 years (depends on configuration)

RF Module complies to

CE, FCC, ARIB

Working temperature

-40°C..+60°C (using Energizer Lithium Ultimate AA battery)

Housing/Protection

Aluminum + Polycarbonate / IP67

Dimension / Net weight

H180xW73xD42 / < 400 grams

4. Dimensions

5. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol)

After 1 minute 30 seconds later the device will send the first data packet and at the same time wait for the downlink packet from the Base Station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent.

REED SWITCH

EVENT

PRE-CONDITION

ACTION

LED STATUS

BUZZER STATUS

ACTIVITIES

POST-CONDITION

2

START_UP

Any state

Move Magnet Key to contact point of REED SWITCH and hold 5s.Buzzer beep 1 long time.

Blink WHITE

Beep 1 long time

See FW specs

Device reset

1

FORCE_DATA

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beeps 1 time, move Magnet Key away.

Blink SKY BLUE

Beep 1 time

See FW specs

Back to previous state

1

PARAMETERS_UPDATE

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beeps 1 time, hold Magnet Key 5s.Buzzer beeps 2 times.

Blink PURPLE

Beep 2 times

See FW specs

Back to previous state

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 5s. if shorter than 5s, there will be no data sending.

5.1 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC3

RC4

RC5

RC6

RC7

Uplink center frequency (MHz)

868.130

902.200

923.200

920.800

923.300

865.200

868.800

Downlink center frequency (MHz)

869.525

905.200

922.200

922.300

922.300

866.300

869.100

Uplink data rate (bit/s)

100

600

100

600

100

100

100

Downlink data rate (bit/s)

600

600

600

600

600

600

600

Sigfox recommended EIRP (dBm)

16

24

16

24

14

16

16

Specifics

Duty cycle 1% *

Frequency hopping **

Listen Before Talk ***

Frequency hopping **

Listen Before Talk ***

Duty cycle 1% *

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

5.2 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

5.3 Device behavior & Firmware Specification of NH3 Sensor

Please read sections 5.5 to 5.8 carefully for a better understanding of the configuration

5.3.1 Start-up features

5.3.1.1 Payload fields

EVENT_TYPE

5.3.1.2 Description

START_UP event is prepared every time the device is starting up. It can be either if the device is starting for the first time, or when the device is being reset. The device can be reset by two possible ways, one is thanks to the reed power switch , the other thanks to the DEVICE_RESET flag set in a downlink message.

5.3.1.3 Frame

5.3.1.4 Flowchart

Nominal flow:

Flow when coming from downlink:

5.3.2 Heartbeat feature

5.3.2.1 Parameters

HEARTBEAT_PERIOD

5.3.2.2 Payload fields

EVENT_TYPE

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

5.3.2.3 Description

HEARTBEAT event is prepared every HEARTBEAT_PERIOD. When the uplink message of the HEARTBEAT event is prepared, the latest valid configuration that the device has received is provided through the LATEST_SIGFOX_DOWNLINK field.

The HEARTBEAT event is a Sigfox downlink exchange. Thanks to the downlink message, pre-defined parameters of the device can be modified in order to change the device behavior.

5.3.2.4 Frame

5.3.2.5 Flowchart

5.3.3 Parameters update feature

5.3.3.1 Payload fields

EVENT_TYPE

LATEST_SIGFOX_DOWNLINK

5.3.3.2 Description

When the appropriate action is done by the user on the Reed Switch 2, a PARAMETERS_UPDATE event is generated. When the uplink message of the PARAMETERS_UPDATE event is prepared, the latest valid configuration that the device has received is provided through the LATEST_SIGFOX_DOWNLINK field.

The PARAMETERS_UPDATE event is a Sigfox downlink exchange. Thanks to the downlink message, pre-defined parameters of the device can be modified in order to change the device behavior.

5.3.3.3 Frame

5.3.3.4 Flowchart

5.3.4 NH3 feature

5.3.4.1 Parameters (DLK)

For NH3 measurement

NH3_ENABLE

NH3_MEASURE_PERIOD

For NH3 message feature

NH3_EVENT_ENABLE

NH3_EVENT_PERIOD

For ALERT feature

NH3_ALERT_ENABLE

NH3_ALERT1_MAX_THRESHOLD

NH3_ALERT2_MAX_THRESHOLD

For BLE advertizing

ALERT_FLAG_reset

BLE_BROADCAST_ENABLE

BROADCAST_PERIOD_normal (TBC)

BROADCAST_PERIOD_alert(TBC)

BLE_RF_OUTPUT_POWER

5.3.4.2 Payload fields

EVENT_ID

…

5.3.4.3 Description

NH3 SENSING and EVENT

The NH3 sensing is enabled thanks to the NH3_ENABLE flag.

The NH3 event is enabled thanks to the NH3_EVENT_ENABLE flag.

New NH3 values are taken every NH3_MEASURE_PERIOD.

NH3 event is prepared every NH3_EVENT_PERIOD. Before sending the event, all statistics (minimum, average and maximum for NH3 levels) are computed since the last NH3 event.

NH3 ALERT

The NH3 alert feature is enabled thanks to the NH3_ALERT_ENABLE flag.

The NH3 sensing check against NH3_ALERT1_MAX_THRESHOLD and NH3_ALERT2_MAX_THRESHOLD, is done anytime a NH3 measurement is performed.

If the check reports that the measured level is above NH3_ALERT1_MAX_THRESHOLD or NH3_ALERT2_MAX_THRESHOLD, an ALERT procedure will start. The NH3 measured value will be recorded during the alert as well as the alert duration.

The ALERT message will be sent right after the alert is detected with a DLK request. When alert message is received at Sigfox server, this will initiate to send an available downlink (DLK) at Sigfox server to device. The message will be sent again until a DLK is received every 10 minutes and until the level goes back to a normal level.After a DLK is received, the device will keep sending Alert message every 10 minutes until the alert is over.

During the ALERT procedure, all other Sigfox events are cancelled. Only NH3 measurements is performed and BLE advertising are maintained.

BLE advertising

When the BLE_BROADCAST_ENABLE flag is set to true, the device will broadcast a BLE beacon signal. The signal broadcasted will change according to the following rules:

The BLE NORMAL frame is broadcasted every BROADCAST_PERIOD_normal when the alert_type flag is set to 0.

The BLE ALERT 1 frame is broadcasted every BROADCAST_PERIOD_alert when the alert_type flag is set to 1.

The BLE ALERT 2 frame is broadcasted every BROADCAST_PERIOD_alert when the alert_type flag is set to 2.

5.3.4.4 Frames

5.3.4.5 Flowchart

Sigfox Normal mode

Sigfox Alert mode

If the message counter reaches a value above the maximum possible tentative field value (255) in the NH3_ALERT message, the tentative value should be kept at the maximum (255).

BLE broadcast

BLE broadcast format

5.4 Light and sound indicator

The light indicator is always in RF listening mode and searching for a beacon signal from the sensor it is attached to.

The indicator device will be able to identify the beacon signal transmitted by the NH3 sensor it is attached to and only consider the beacon signal from that specific sensor.

Some simple synchronization mechanisms will be implemented in order to minimize the power consumption of the receiver to an acceptable level.

Depending on the beacon received, the indicator device will have the behavior described in the following flowcharts:

No Signal:

Signal received « OK »:

Signal received « ALERT 1 »:

Signal received « ALERT 2 »:

5.5 Pairing with BLE Indicator

Insert the batteries into Sigfox NH3-BLE device, wait 1 minute for configuration stage end, then Sigfox NH3-BLE will broadcast BLE data.

Then insert the batteries into BLE Indicator, place it near to Sigfox NH3BLE

When BLE Indicator has got ID NOT MATCH with ID from Sigfox NH3-BLE, BLE Indicator will beep 2 times. So you need to clear that ID before pairing the BLE Indicator with the new Sigfox device. To clear the ID in BLE Indicator, place magnet key to reed switch area (marked as a magnet on the nameplate), the BLE indicator will beep 1 time, and the status led (the led on side of the board) blink WHITE.

It is recommended that when adding an ID to a BLE Indicator you should clear the ID first.

After clearing the ID of the BLE Indicator, you may wait for up to 1 minute for it to pair with the new Sigfox device. When pairing is successful, you can hear 1 beep sound;

When BLE Indicator have ID MATCH with ID from Sigfox NH3BLE , BLE Indicator will operation normal (details in Firmware Specifications Sound and light indicator)

5.6 Event ID

Event Typebits

EVENT_ID4

COLOR

START_UP

0

WHITE

HEARTBEAT

1

GREEN

PARAMETERS_UPDATE

2

PURPLE

NH3_FORCE_DATA

3

SKY BLUE

NH3

4

SKY BLUE

NH3_ALERT

5

RED

Not used

6

Not used

7

Not used

8

Not used

9

Not used

10

Not used

11

Not used

12

Not used

13

Not used

14

Not used

15

5.7 Configuration Parameters

Should not change the value in the Blue cells

Category

Parameter

Description

Possible values

Default value

Length (in bits)

DEVICE

LED_BUZZER_ENABLE

Flag to enable/disable LED and Buzzer interactions for action not triggered by the button.

0b0 = false, LEDs are OFF0b1 = true, LEDs are ON

0b0 = false

1

DEVICE

DEVICE_RESET

Once this parameter is set, the device shall restart once after having received the DL.

0b1010 = 0xA = Force device resetothers = do nothing

others = do nothing

4

DEVICE

TX_REPEAT

Number of Sigfox frames

0b0 =  1 frames0b1 = 3 frames

0b0 = 1 frames

1

HEARTBEAT

HEARTBEAT_PERIOD

Period of time to send HEARTBEAT event

0b000 = every  1h0b001 = every  6h0b010 = every 12h0b011 = every 24h (1 day)0b100 = every 48h (2 day)0b101 = every 72h (3 day)0b110 = every 120h (5 day)0b111 = every 240h (10 day)

0b100= every 48h (2 days)

3

NH3

NH3_ENABLE

Enable NH3 sensing

0b0 = false, NH3 sensing is disabled0b1 = true, NH3 sensing is enabled

0b1 = true

1

NH3

NH3_MEASURE_PERIOD

Interval of time between two consecutive NH3 values are acquired

0b0000 = every 1s0b0001 = every 2s0b0010 = every 5s0b0011 = every 10s0b0100 = every 20s0b0101 = every 30s0b0110 = every 1min0b0111 = every 2min0b1000 = every 5min0b1001 = every  10min0b1010 = every 20min0b1011 = every 30min0b1100 = every 1h0b1101 = every 2h0b1110 = every 3h0b1111 = every 6h

0b0010 = every 5s

4

NH3

NH3_EVENT_ENABLE

Enable NH3 event

0b0 = false, NH3 event is disabled0b1 = true, NH3 event is enabled

0b1 = true

1

NH3

NH3_EVENT_PERIOD

Interval of time between two consecutive NH3 events

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b010 = every 1h

3

NH3

NH3_ALERT ENABLE

Enable NH3_ALERT event

0b0 = false, NH3 ALERT feature is disabled0b1 = true, NH3 ALERT feature is enabled

0b0 = false, NH3 ALERT feature is disabled

1

NH3

NH3_ALERT1_MAX_THRESHOLD

Threshold #1 on the temperature to trig a NH3_ALERT event

8-bit unsigned integerFormula: (8-bit_NH3ppm*2)= real_NH3_level_in_ppmRange: 0 to 100ppmAccuracy: 0.5ppmExample: 0b01110100 = 0x74 = 116 => (116 / 2) = 58ppm

0b00001010 = 5ppm

8

NH3

NH3_ALERT2_MAX_THRESHOLD

Threshold #2on the temperature to trig a NH3_ALERT event

8-bit unsigned integerFormula: (8-bit_NH3ppm*2)= real_NH3_level_in_ppmRange: 0 to 100ppmAccuracy: 0.5ppmExample: 0b01110100 = 0x74 = 116 => (116 / 2) = 58ppm

0b00010100 = 10ppm

8

NH3

ALERT_FLAG_reset

Flag to reset the BLE broadcast mechanism and set it back to normal.

0b1010 = 0xA = leave BLE alert modeothers = do nothing

others = do nothing

1

BLE

BLE_BROADCAST_ENABLE

Enable BLE advertising functionality

0b0 = false, BLE advertising feature is disabled0b1 = true, BLE advertising feature is enabled

0b1 = true, BLE advertising feature is enabled

1

BLE

BROADCAST_PERIOD_normal

Broacasting period when the device is in normal mode

0b000 = every 1s0b001 = every 2s0b010 = every 5s0b011 = every 10s0b100 = every 30s0b101 = every 1 min0b110 = every 2 min0b111 = every 5 min

0b011 = every 10s

3

BLE

BROADCAST_PERIOD_alert

Broacasting period when the device is in alert mode

0b000 = every 1s0b001 = every 2s0b010 = every 5s0b011 = every 10s0b100 = every 30s0b101 = every 1 min0b110 = every 2 min0b111 = every 5 min

0b001 = every  2s

3

BLE

BLE_RF_OUTPUT_POWER

Transmit power level

0b000 =  -20dBm0b001 = -10dBm0b010 =  0dBm0b011 =  5dBm

0b000 =  -20dBm

3

5.8 Payload Data

The following is the format of payload data that will be sent to the Sigfox server.

5.8.1 Payload Fields

Category

Data name

Description

Encoding or Possible values

Length (in bits)

DEVICE

EVENT_ID

Unique ID identifying the device event

4-bit unsigned integerPossible values: As defined in Event ID tab

4

DEVICE

LATEST_SIGFOX_DOWNLINK

The Latest received and valid Sigfox downlink frame

64-bit encoded fieldSee Sigfox Downlink tab

64

DEVICE

HW_VERSION

Indicate HW  version

4-bit unsigned integerHW_VERSION = HW_VERSION value in EEPROM set in productionif Value unknown, default value will be 0

4

DEVICE

FW_VERSION

indicate FW version

8-bit unsigned integerRefer to FW release note

8

NH3

NH3

NH3 level of the surrounding environment of the device

16-bit unsigned integerFormula: (16-bit_NH3ppm/100)= real_NH3_level_in_ppmRange: 0 to 100ppmAccuracy: 0.01ppmExample: 0x16B7 = 5815 => (5815 / 100) = 58.15ppm

16

Type

ALERT_TYPE

Type of alert

2-bit unsigned integer0b0 = Not used0b1 = Alert type 10b10 = Alert type 20b11 = Not used

2

TIME

ALERT_DURATION

Alert duration in hours

8-bit unsigned integerFormula: 8-bit_Alert_duration =  real_TempAlert_duration_in_hoursRange: 0 to 255 hoursAccuracy: 1 hourExample: 0b00100000 = 0x20 = 32 =>  32 hours

8

Tentative

TENTATIVE

Tentative number

8-bit unsigned integerFormula: (8-bit_Tentativve +1)= real_tentative #Range: 1 to 256Accuracy: 1Example: 0b00000111 = 0x7=7=> 7+1 =>tentative # 8

8

5.8.2 Sigfox Uplink Frame Format

For more details, you can download the file HERE

Size

Event Type

EVENT_ID

HW_VERSION

FW_VERSION

CURRENT CONFIGURATION

10.0

bits

4

4

8

64

Payload data format

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

START_UP

yes

yes

yes

yes

Event Type

EVENT_ID

HW_VERSION

FW_VERSION

CURRENT CONFIGURATION

10.0

bits

4

4

8

64

Payload data format

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

HEARTBEAT

yes

yes

yes

yes

Event Type

EVENT_ID

HW_VERSION

FW_VERSION

CURRENT CONFIGURATION

10.0

bits

4

4

8

64

Payload data format

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

PARAMETERS_UPDATE

yes

yes

yes

yes

Event Type

EVENT_ID

HW_NH3_ERROR

RESERVED

NH3

3.0

bits

4

1

3

16

Payload data format

EVENT_ID

HW_NH3_ERROR

-

NH3

NH3_FORCE_DATA

yes

yes

zeros

yes

Event Type

EVENT_ID

HW_NH3_ERROR

RESERVED

NH3

MIN_NH3

AVG_NH3

MAX_NH3

9.0

bits

4

1

3

16

16

16

16

Payload data format

EVENT_ID

HW_NH3_ERROR

-

NH3

NH3

NH3

NH3

NH3

yes

yes

zeros

yes

yes

yes

yes

Event Type

EVENT_ID

HW_NH3_ERROR

RESERVED

ALERT_TYPE

EXTREME_NH3

ALERT_DURATION

TENTATIVE

5.0

bits

4

1

1

2

16

8

8

Payload data format

EVENT_ID

HW_NH3_ERROR

-

ALERT_TYPE

NH3

ALERT_DURATION

TENTATIVE

NH3_ALERT

yes

yes

zeros

yes

yes

yes

yes

5.8.3 Sigfox Downlink Frame Format.

The Sigfox node is only able to receive max 04 downlinks a day, each downlink will be waiting in every 06 hours.

User can set the down link data in Sigfox back-end system in advance, whenever the Sigfox node connected to base stations and with downlink waiting is enable at that time (one time in 6 hours), the downlink data will be loaded to Sigfox node.

The downlink data can be any configuration parameter.

Please pay attention when send downlink data. If there was a mistake in sending wrong data, it would cause the Sigfox node not working properly and user need to configure it by offline cable!!!

For more details, you can download the file HERE

Downlink Frame Format:

Downlink type= 0b0000

Downlink type= 0b0101

5.9 BLE Broadcast Format

Size

Broadcast Type

EDDYSTONE HEADER

DEVICE_ID

ALERT_TYPE

ALERT_

FLAG_

reset

HW_

NH3_

ERROR

HW_

VERSION

FW_

VERSION

CURRENT CONFIGURATION

NH3

28.0

bits

96

32

2

1

1

4

8

64

16

Payload data format

EDDYSTONE HEADER

DEVICE_ID

ALERT_TYPE

ALERT_

FLAG_

reset

HW_

NH3_

ERROR

HW_

VERSION

FW_

VERSION

LATEST_

SIGFOX_

DOWNLINK

NH3

BLE Broadcast: OK ALERT_TYPE = 0

0x0201040303AAFEXX16AAFE20

yes

yes

yes

yes

yes

yes

yes

yes

Size

Broadcast Type

EDDYSTONE HEADER

DEVICE_ID

ALERT_TYPE

ALERT_

FLAG_

reset

HW_

NH3_

ERROR

HW_

VERSION

FW_

VERSION

CURRENT CONFIGURATION

NH3

28.0

bits

96

32

2

1

1

4

8

64

16

Payload data format

EDDYSTONE HEADER

DEVICE_ID

ALERT_TYPE

ALERT_

FLAG_

reset

HW_

NH3_

ERROR

HW_

VERSION

FW_

VERSION

LATEST_

SIGFOX_

DOWNLINK

NH3

BLE Broadcast: OKALERT_TYPE = 1 or 2ALERT_FLAG_reset = 1

0x0201040303AAFEXX16AAFE20

yes

yes

yes

yes

yes

yes

yes

yes

Size

Broadcast Type

EDDYSTONE HEADER

DEVICE_ID

ALERT_TYPE

ALERT_

FLAG_

reset

HW_

NH3_

ERROR

HW_

VERSION

FW_

VERSION

CURRENT CONFIGURATION

NH3

28.0

bits

96

32

2

1

1

4

8

64

16

Payload data format

EDDYSTONE HEADER

DEVICE_ID

ALERT_TYPE

ALERT_

FLAG_

reset

HW_

NH3_

ERROR

HW_

VERSION

FW_

VERSION

LATEST_

SIGFOX_

DOWNLINK

NH3

BLE Broadcast: ALERT 1ALERT_TYPE = 1ALERT_FLAG_reset = 0

0x0201040303AAFEXX16AAFE20

yes

yes

yes

yes

yes

yes

yes

yes

Size

Broadcast Type

EDDYSTONE HEADER

DEVICE_ID

ALERT_TYPE

ALERT_

FLAG_

reset

HW_

NH3_

ERROR

HW_

VERSION

FW_

VERSION

CURRENT CONFIGURATION

NH3

28.0

bits

96

32

2

1

1

4

8

64

16

Payload data format

EDDYSTONE HEADER

DEVICE_ID

ALERT_TYPE

ALERT_

FLAG_

reset

HW_

NH3_

ERROR

HW_VERSION

FW_VERSION

LATEST_

SIGFOX_

DOWNLINK

NH3

BLE Broadcast: ALERT 2ALERT_TYPE = 2ALERT_FLAG_reset = 0

0x0201040303AAFEXX16AAFE20

yes

yes

yes

yes

yes

yes

yes

yes

6. Modbus Memmap

6.1 Data table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

2

2

3

4

firmware version

string

Read

6

6

3

2

hardware version

string

Read

8

8

3

2

device ID

hex

Read

Product ID

10

A

3

4

device PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

6.2 Configuration table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

274

112

3

16

1

SERVER_CONFIG

uint16

Read / Write

0: Send to Sigfox Network1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1, 2, 4

4

uint16

Read / Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

277

115

3

16

1

TX_POWER

20

int16

Read / Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read / Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

0

float

Read / Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1E+09

float

Read / Write

High cut value for calculated value

284

11C

3

16

2

LOW_CUT

-1E+09

float

Read / Write

Low cut value for calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

200

uint32

Read / Write

Boot time of sensor/input, in ms

306

132

3

16

2

SYSTEM_SENSITIVITY

11

float

Read / Write

The sensitivity of the circuit (mV/ppm)

7. Offline configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=yDOjE5d6kqFlGNVVlMdFg19Aad6aw0Hs

How to use the Modbus configuration software

Step 2: Plug the configuration cable to Computer via USB port;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name NH3 Sensor-2021.10.30-Template-V1.2.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-NH3

8. Installation

8.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

8.2 Mounting

Installation method: Mount to the wall

The mounting bracket is made from hard metallic material

8.3 Battery installation

Steps for battery installation:

Step 1: Using M4 Hex key to open the cover

Step 2: Open the housing, then insert 02 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing (Please note the 2 reed joint)

9. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply or battery ran out

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Or place the Magnet key not right position

Locate the correct position for magnet key

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages of uplink per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

Contact manufacturer

6

The measurement values from sensor do not change, keep constant values for long time

Sensor got failure

Sensor cable broken

Sensor connector is not connected firmly

Check sensor cable and connector

If the issue is still exist, please contact manufacturer for warranty or replace new sensor

7

The node does not send RF and the RF module is hot

Insert the battery in the wrong direction

Electronics got problem

Check battery polarity

8

RSSI is weak and often loses data

Distance between Node and Base station is far or there are many obstructions

Connection to Antenna problem

Check the location of Sigfox node and distance to the base station

Check the antenna connector in the PCB

10. Sensor calibration

The output value of NH3 is calculated from the formula: Y= AX + B

Where:

X = measured value of NH3 from sensor and electronics circuit

Y = output value of NH3 which is sent by the Uplink

A: Constant_A at address 278 in Memmap of sensor

B: Constant_B at address 280 in Memmap of sensor

The default values are: A = 1 and B = 0 ==> Y = X

After a period of time of working the sensor output will be drifted about < 1% of the reading value per month.

So depending on what accuracy you require, you can define how long the sensor needs to be re-calibrated again.

For general application, the cycle of calibration would be 3 or 6 months. For the highest accuracy, the cycle would be 1 or 2 months.

To re-calibrate the sensor, you need to re-calculation the new values of A and B. How can it be done?

By applying the standard Zero and Span Gas. Please follow these steps:

10.1 Apply zeroing gas standard:

Before applying zeroing process, please do this step first: place the sensor in a Pure air environment from 20-25 oC in at least 1h. The sensor must be powered and running at the time.

Zeroing can be done in 1 of 2 ways as below:

- Pure air can be used as a Zero standard for NH3 calibration. Simply place the sensor in a clean environment with pure air. The ambient temperature should be from 20 to 25 oC.

- Or using high purity Nitrogen gas (99.999%) as a zero standard gas. Attach the calibration cap into the sensor and turn on the Valve to provide the N2 flow into the sensor.

Waiting for the zero gas to enter completely into the sensor for at least 15 minutes, then using the magnet key to activate the SW1. This action will force the sensor to send the new measured data to the Sigfox backend, you got the measured value Y_o.

10.2 Apply span gas standard:

As the sensor has the maximum measurement range is 100ppm, you can use any standard NH3 gas cylinder with a concentration from 25ppm to 100ppm for calibration. Please follow the steps below:

- Attach the calibration cap into the sensor and turn on the Valve of the cylinder to provide the span gas flow into the sensor.

Waiting for the span gas to enter completely into the sensor for at least 5 minutes, then using the magnet key to activate the SW1. This action will force the sensor to send the new measured data to the Sigfox backend, you got the measured value Y_s.

10.3 Calculate the new value A and B

From the existing A and B values and the measured value Y_o and Y_s and the 0ppm (zero standards) and 25ppm (for example using 25ppm NH3 standard gas), you can calculate the new value of A and B as below formula.

Ex: We have values

Two calibration points

Standard value

The value read from Sigfox device

1

50

70

2

1000

1100

The old A configuration

1

The old B configuration

0

We have:

A = (1000-50) / (1100-70) = 0.92233

From the formula: Y = AX + B. Then B = Y - AX = 1000 - 0.92233 x 1100 = -14.56311

The new A configuration

0.92233

The new B configuration

-14.56311

10.4 Set the new value A and B by Downlink

As the A and B values are separated values in the memmap of the sensor, we need to use 02 downlink messages to send to the sensor. Each message will send 1 value of A or B.

For example: A = 1.1 and B = 0.2. Here are the downlink message for setting A & B

Parameter

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

DOWNLINK_TYPE

Full Downlink

(bytes)

1

1

4

2

8

CONSTANT_A

0x16

0x04 = 4

0x3F8CCCCD = 1.1

0x0005

16043F8CCCCD0005

CONSTANT_B

0x18

0x04 = 4

0x3E4CCCCD = 0.2

0x0005

18043E4CCCCD0005

HIGH_CUT

0x1A

0x04 = 4

0x447A0000 = 1000

0x0005

1A04447A00000005

LOW_CUT

0x1C

0x04 = 4

0x00000000 = 0

0x0005

1C04000000000005

SENSOR_BOOT_TIME

0x1E

0x04 = 4

0x000000C8 = 200

0x0005

1E04000000C80005

SYSTEM_SENSITIVITY

0x32

0x04 = 4

0x41300000 = 11

0x0005

3204413000000005

11. Sensor module replacement:

11.1 Remove old sensor module:

- Carefully remove the filter;

- Remove the exiting sensor module by using your finger to grip and pull it out;

11.2 Install new sensor module:

- Unbox the new sensor in the box;

- Carefully remove the spring between the 02 pins of the sensor, as below picture;

- Plug the sensor module into the device. Make sure the 03 pins of the sensor are completely inserted inside the sockets. Please see the below picture.

- Place the filter again and tighten it.

12. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

USER GUIDE FOR SIGFOX-READY AMMONIA TOILET SENSOR WSSFC-G4F-NH3

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC-G4F-NH3-MN-EN-01

DEC-2021

This document is applied for the following products

SKU

WSSFC-G4F-NH3

HW Ver.

1.1

FW Ver.

1.0

Item Code

WSSFC-G4F-NH3-8-01

SIGFOX AMMONIA TOILET SENSOR, INTERNAL ANTENNA, TYPE AA BATTERY 3.6VDC, IP67, RC1 zone

WSSFC-G4F-NH3-9-01

SIGFOX AMMONIA TOILET SENSOR, INTERNAL ANTENNA, TYPE AA BATTERY 3.6VDC, IP67, RC2-RC4 zones

0. Configuration Check List

STEP 1: Select RC

1. Select RC zone

RC zones selection 1, 2, 4,... is RCZ1, RCZ2, RCZ4,...  (refer to section 6)

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section 6

STEP 4:  Add device to Backend Sigfox

refer to section 6.2 for details

STEP 5:  Installation

refer to section 8  for details

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.1

1.0

DEC-2020

2. Introduction

WSSFC-G4F-NH3 is a Sigfox-ready sensor with built-in electrochemical gas sensor to measure Ammonia NH3 gas concentration to measure Toilet odor level. With Ultra-low power design and smart firmware allow the complete Wireless and Sensor package run on 2 x AA battery 1.5VDC for 2-5 years with 15 minutes update. It can support all regions of Sigfox network in over the World, RC1, RC2, RC3, RC4, RC5, RC6, RC7.

Typical Applications: Monitor Ammonia in private or public toilets.

3. Specification

SENSORS SPECIFICATION:

NH3 sensor

electrochemical-type gas sensor

Measuring range for NH3

0..100 ppm

Max detecting concentration

200 ppm

Repeatability / Resolution / Stability per month

< 10% of Reading value / 1 ppm / < 2% of Reading value

Zero stability

+/- 2 ppm

Working atmospheric pressure

101.3 Kpa +/- 10%

Sensor life

> 2 years

Humidity and Temperature sensor

Digital type, factory calibrated

Humidity measuring range / accuracy / resolution

0 .. 100 %RH, ± 2.0% / 0.1%

Temperature measuring range / accuracy / resolution

-40 .. + 85°C / ± 0.2°C / 0.1°C

Working temperature and humidity

-30 .. + 50°C, 15 .. 90% RH

Sigfox SPECIFICATION:

Sigfox zones

select RC1-RC2-RC4

Antenna

Internal Antenna 2dbi

Battery

02 x AA Type 1.5VDC, working time up to 10 years (depends on configuration)

RF Module complies to

CE, FCC, ARIB

Working temperature

-40°C..+60°C (using Energizer Lithium Ultimate AA battery)

Housing/Protection

ABS

Dimension / Net weight

H180xW73xD42 / < 400 grams

4. Dimensions

5. Scope of delivery

Wireless ultrasonic level sensor

Magnet key

Screws

6. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol)

After 1 minute 30 seconds later the device will send the first data packet and at the same time wait for the downlink packet from the Base Station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent.

REED SWITCH

EVENT

PRE-CONDITION

ACTION

BUZZER STATUS

ACTIVITIES

POST-CONDITION

1

FORCE_DATA

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beeps 1 time, move Magnet Key away.

Beep 1 time

To send measured values immediately

Back to previous state

1

PARAMETERS_UPDATE

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beeps 1 time, hold Magnet Key 5s.Buzzer beeps 2 times.

Beep 2 times

To send current configuration and get downlink for new configuration

Back to previous state

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 5s. if shorter than 5s, there will be no data sending.

6.1 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC3

RC4

RC5

RC6

RC7

Uplink center frequency (MHz)

868.130

902.200

923.200

920.800

923.300

865.200

868.800

Downlink center frequency (MHz)

869.525

905.200

922.200

922.300

922.300

866.300

869.100

Uplink data rate (bit/s)

100

600

100

600

100

100

100

Downlink data rate (bit/s)

600

600

600

600

600

600

600

Sigfox recommended EIRP (dBm)

16

24

16

24

14

16

16

Specifics

Duty cycle 1% *

Frequency hopping **

Listen Before Talk ***

Frequency hopping **

Listen Before Talk ***

Duty cycle 1% *

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

6.2 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

6.3 Device behavior & Firmware Specification of NH3 Sensor

Please read sections 6.5 to 6.8 carefully for a better understanding of the configuration

6.3.1 Heartbeat feature

6.3.1.1 Parameters

HEARTBEAT_PERIOD

6.3.1.2 Payload fields

EVENT_TYPE

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

6.3.1.3 Description

HEARTBEAT event is prepared every HEARTBEAT_PERIOD. When the uplink message of the HEARTBEAT event is prepared, the latest valid configuration that the device has received is provided through the LATEST_SIGFOX_DOWNLINK field.

The HEARTBEAT event is a Sigfox downlink exchange. Thanks to the downlink message, pre-defined parameters of the device can be modified in order to change the device behavior.

6.3.2.4 Frame

6.3.1.5 Flowchart

6.3.2 Parameters update feature

6.3.2.1 Payload fields

EVENT_TYPE

LATEST_SIGFOX_DOWNLINK

6.3.2.2 Description

When the appropriate action is done by the user on the Reed Switch 2, a PARAMETERS_UPDATE event is generated. When the uplink message of the PARAMETERS_UPDATE event is prepared, the latest valid configuration that the device has received is provided through the LATEST_SIGFOX_DOWNLINK field.

The PARAMETERS_UPDATE event is a Sigfox downlink exchange. Thanks to the downlink message, pre-defined parameters of the device can be modified in order to change the device behavior.

6.3.2.3 Frame

6.3.2.4 Flowchart

6.3.3 NH3 feature

6.3.3.1 Parameters (DLK)

For NH3 measurement

NH3_ENABLE

NH3_MEASURE_PERIOD

For NH3 message feature

NH3_EVENT_ENABLE

NH3_EVENT_PERIOD

For ALERT feature

NH3_ALERT_ENABLE

NH3_ALERT1_MAX_THRESHOLD

NH3_ALERT2_MAX_THRESHOLD

For BLE advertizing

ALERT_FLAG_reset

BLE_RF_OUTPUT_POWER

6.3.3.2 Payload fields

EVENT_ID

…

6.3.3.3 Description

NH3 SENSING and EVENT

The NH3 sensing is enabled thanks to the NH3_ENABLE flag.

The NH3 event is enabled thanks to the NH3_EVENT_ENABLE flag.

New NH3 values are taken every NH3_MEASURE_PERIOD.

NH3 event is prepared every NH3_EVENT_PERIOD. Before sending the event, all statistics (minimum, average and maximum for NH3 levels) are computed since the last NH3 event.

NH3 ALERT

The NH3 alert feature is enabled thanks to the NH3_ALERT_ENABLE flag.

The NH3 sensing check against NH3_ALERT1_MAX_THRESHOLD and NH3_ALERT2_MAX_THRESHOLD, is done anytime a NH3 measurement is performed.

If the check reports that the measured level is above NH3_ALERT1_MAX_THRESHOLD or NH3_ALERT2_MAX_THRESHOLD, an ALERT procedure will start. The NH3 measured value will be recorded during the alert as well as the alert duration.

The ALERT message will be sent right after the alert is detected with a DLK request.The message will be sent again until a DLK is received every 10 minutes and until the level goes back to a normal level.After a DLK is received, the device will keep sending Alert message every 10 minutes until the alert is over.

During the ALERT procedure, all other Sigfox events are cancelled. Only NH3 measurements is performed and BLE advertising are maintained.

6.3.3.4 Frames

6.3.3.5 Flowchart

Sigfox Normal mode

Sigfox Alert mode

If the message counter reaches a value above the maximum possible tentative field value (255) in the NH3_ALERT message, the tentative value should be kept at the maximum (255).

6.4 Light and sound indicator

The light indicator is always in RF listening mode and searching for a beacon signal from the sensor it is attached to.

The indicator device will be able to identify the beacon signal transmitted by the NH3 sensor it is attached to and only consider the beacon signal from that specific sensor.

Some simple synchronization mechanisms will be implemented in order to minimize the power consumption of the receiver to an acceptable level.

Depending on the beacon received, the indicator device will have the behavior described in the following flowcharts:

No Signal:

Signal received « OK »:

Signal received « ALERT 1 »:

Signal received « ALERT 2 »:

6.5 Event ID

Event Typebits

EVENT_ID4

COLOR

START_UP

0

WHITE

HEARTBEAT

1

GREEN

PARAMETERS_UPDATE

2

PURPLE

NH3_FORCE_DATA

3

SKY BLUE

NH3

4

SKY BLUE

NH3_ALERT

5

RED

Not used

6

Not used

7

Not used

8

Not used

9

Not used

10

Not used

11

Not used

12

Not used

13

Not used

14

Not used

15

6.6 Configuration Parameters

Category

Parameter

Description

Possible values

Default value

Length (in bits)

DEVICE

LED_BUZZER_ENABLE

Flag to enable/disable LED and Buzzer interactions for action not triggered by the button.

0b0 = false, LEDs are OFF0b1 = true, LEDs are ON

0b0 = false

1

DEVICE

DEVICE_RESET

Once this parameter is set, the device shall restart once after having received the DL.

0b1010 = 0xA = Force device resetothers = do nothing

others = do nothing

4

DEVICE

TX_REPEAT

Number of Sigfox frames

0b0 =  1 frames0b1 = 3 frames

0b0 = 1 frames

1

HEARTBEAT

HEARTBEAT_PERIOD

Period of time to send HEARTBEAT event

0b000 = every  1h0b001 = every  6h0b010 = every 12h0b011 = every 24h (1 day)0b100 = every 48h (2 day)0b101 = every 72h (3 day)0b110 = every 120h (5 day)0b111 = every 240h (10 day)

0b100= every 48h (2 days)

3

NH3

NH3_ENABLE

Enable NH3 sensing

0b0 = false, NH3 sensing is disabled0b1 = true, NH3 sensing is enabled

0b1 = true

1

NH3

NH3_MEASURE_PERIOD

Interval of time between two consecutive NH3 values are acquired

0b0000 = every 1s0b0001 = every 2s0b0010 = every 5s0b0011 = every 10s0b0100 = every 20s0b0101 = every 30s0b0110 = every 1min0b0111 = every 2min0b1000 = every 5min0b1001 = every  10min0b1010 = every 20min0b1011 = every 30min0b1100 = every 1h0b1101 = every 2h0b1110 = every 3h0b1111 = every 6h

0b0010 = every 5s

4

NH3

NH3_EVENT_ENABLE

Enable NH3 event

0b0 = false, NH3 event is disabled0b1 = true, NH3 event is enabled

0b1 = true

1

NH3

NH3_EVENT_PERIOD

Interval of time between two consecutive NH3 events

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b010 = every 1h

3

NH3

NH3_ALERT ENABLE

Enable NH3_ALERT event

0b0 = false, NH3 ALERT feature is disabled0b1 = true, NH3 ALERT feature is enabled

0b0 = false, NH3 ALERT feature is disabled

1

NH3

NH3_ALERT1_MAX_THRESHOLD

Threshold #1 on the temperature to trig a NH3_ALERT event

8-bit unsigned integerFormula: (8-bit_NH3ppm*2)= real_NH3_level_in_ppmRange: 0 to 100ppmAccuracy: 0.5ppmExample: 0b01110100 = 0x74 = 116 => (116 / 2) = 58ppm

0b00001010 = 5ppm

8

NH3

NH3_ALERT2_MAX_THRESHOLD

Threshold #2on the temperature to trig a NH3_ALERT event

8-bit unsigned integerFormula: (8-bit_NH3ppm*2)= real_NH3_level_in_ppmRange: 0 to 100ppmAccuracy: 0.5ppmExample: 0b01110100 = 0x74 = 116 => (116 / 2) = 58ppm

0b00010100 = 10ppm

8

NH3

ALERT_FLAG_reset

Flag to reset the BLE broadcast mechanism and set it back to normal.

0b1010 = 0xA = leave BLE alert modeothers = do nothing

others = do nothing

1

6.7 Payload Data

The folllowing is the format of payload data will be sent to Sigfox server.

6.7.1 Payload Fields

Category

Data name

Description

Encoding or Possible values

Length (in bits)

DEVICE

EVENT_ID

Unique ID identifying the device event

4-bit unsigned integerPossible values: As defined in Event ID tab

4

DEVICE

LATEST_SIGFOX_DOWNLINK

Latest received and valid sigfox downlink frame

64-bit encoded fieldSee Sigfox Downlink tab

64

DEVICE

HW_VERSION

Indicate HW  version

4-bit unsigned integerHW_VERSION = HW_VERSION value in EEPROM set in productionif Value unknown, default value will be 0

4

DEVICE

FW_VERSION

indicate FW version

8-bit unsigned integerRefer to FW release note

8

NH3

NH3

NH3 level of the surrounding environment of the device

16-bit unsigned integerFormula: (16-bit_NH3ppm/100)= real_NH3_level_in_ppmRange: 0 to 100ppmAccuracy: 0.01ppmExample: 0x16B7 = 5815 => (5815 / 100) = 58.15ppm

16

Type

ALERT_TYPE

Type of alert

2-bit unsigned integer0b0 = Not used0b1 = Alert type 10b10 = Alert type 20b11 = Not used

2

TIME

ALERT_DURATION

Alert duration in hours

8-bit unsigned integerFormula: 8-bit_Alert_duration =  real_TempAlert_duration_in_hoursRange: 0 to 255 hoursAccuracy: 1 hourExample: 0b00100000 = 0x20 = 32 =>  32 hours

8

Tentative

TENTATIVE

Tentative number

8-bit unsigned integerFormula: (8-bit_Tentativve +1)= real_tentative #Range: 1 to 256Accuracy: 1Example: 0b00000111 = 0x7=7=> 7+1 =>tentative # 8

8

6.7.2 Sigfox Uplink Frame Format

Size

Event Type

EVENT_ID

HW_VERSION

FW_VERSION

CURRENT CONFIGURATION

10.0

bits

4

4

8

64

Payload data format

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

START_UP

yes

yes

yes

yes

Event Type

EVENT_ID

HW_VERSION

FW_VERSION

CURRENT CONFIGURATION

10.0

bits

4

4

8

64

Payload data format

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

HEARTBEAT

yes

yes

yes

yes

Event Type

EVENT_ID

HW_VERSION

FW_VERSION

CURRENT CONFIGURATION

10.0

bits

4

4

8

64

Payload data format

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

PARAMETERS_UPDATE

yes

yes

yes

yes

Event Type

EVENT_ID

HW_NH3_ERROR

RESERVED

NH3

3.0

bits

4

1

3

16

Payload data format

EVENT_ID

HW_NH3_ERROR

-

NH3

NH3_FORCE_DATA

yes

yes

zeros

yes

Event Type

EVENT_ID

HW_NH3_ERROR

RESERVED

NH3

MIN_NH3

AVG_NH3

MAX_NH3

9.0

bits

4

1

3

16

16

16

16

Payload data format

EVENT_ID

HW_NH3_ERROR

-

NH3

NH3

NH3

NH3

NH3

yes

yes

zeros

yes

yes

yes

yes

Event Type

EVENT_ID

HW_NH3_ERROR

RESERVED

ALERT_TYPE

EXTREME_NH3

ALERT_DURATION

TENTATIVE

5.0

bits

4

1

1

2

16

8

8

Payload data format

EVENT_ID

HW_NH3_ERROR

-

ALERT_TYPE

NH3

ALERT_DURATION

TENTATIVE

NH3_ALERT

yes

yes

zeros

yes

yes

yes

yes

6.7.3 Sigfox Downlink Frame Format.

The Sigfox node is only able to receive max 04 downlinks a day, each downlink will be waiting in every 06 hours.

User can set the down link data in Sigfox back-end system in advance, whenever the Sigfox node connected to base stations and with downlink waiting is enable at that time (one time in 6 hours), the downlink data will be loaded to Sigfox node.

The downlink data can be any configuration parameter.

Please pay attention when send downlink data. If there was a mistake in sending wrong data, it would cause the Sigfox node not working properly and user need to configure it by offline cable!!!

For more details, you can download the file HERE

Downlink Frame Format:

Downlink type= 0b0000

Downlink type= 0b0101

7. Modbus Memmap

7.1 Data table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

2

2

3

4

firmware version

string

Read

6

6

3

2

hardware version

string

Read

8

8

3

2

device ID

hex

Read

Product ID

10

A

3

4

device PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

7.2 Configuration table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/ Write

274

112

3

16

1

SERVER_CONFIG

uint16

Read / Write

0: Send to Sigfox Network1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1, 2, 4

4

uint16

Read / Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

277

115

3

16

1

TX_POWER

20

int16

Read / Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read / Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

0

float

Read / Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1E+09

float

Read / Write

High cut value for calculated value

284

11C

3

16

2

LOW_CUT

-1E+09

float

Read / Write

Low cut value for calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

200

uint32

Read / Write

Boot time of sensor/input, in ms

306

132

3

16

2

SYSTEM_SENSITIVITY

11

float

Read / Write

The sensitivity of the circuit (mV/ppm)

8. Offline configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=yDOjE5d6kqFlGNVVlMdFg19Aad6aw0Hs

How to use the Modbus configuration software

Step 2: Plug the configuration cable to Computer via USB port;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name NH3 Sensor-2021.10.30-Template-V1.2.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR WSSFC-G4F-NH3

9. Installation

9.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

9.2 Mounting

Installation method: Mount to the wall or ceiling

9.3 Battery installation

Steps for battery installation:

Step 1: Open the cover by using flat head screwdriver

Step 2: Insert 02 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Reinstall the bottom housing, please take note slot of the housing

10. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply or battery ran out

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Or place the Magnet key not right position

Locate the correct position for magnet key

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages of uplink per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

Contact manufacturer

6

The measurement values from sensor do not change, keep constant values for long time

Sensor got failure

Sensor cable broken

Sensor connector is not connected firmly

Check sensor cable and connector

If the issue is still exist, please contact manufacturer for warranty or replace new sensor

7

The node does not send RF and the RF module is hot

Insert the battery in the wrong direction

Electronics got problem

Check battery polarity

8

RSSI is weak and often loses data

Distance between Node and Base station is far or there are many obstructions

Connection to Antenna problem

Check location of Sigfox node and distance to base station

Check the antenna connector in the PCB

11. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

USER GUIDE FOR SIGFOX TILT SENSOR WSSFC-AG

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC-AG-MN-EN-01

FEB-2022

This document is applied for the following products

SKU

WSSFC-AG

HW Ver.

1.0

FW Ver.

1.02

Item Code

WSSFC-AG-9-01

Sigfox XYZ Tilt sensor, Internal antenna, Type AA battery 1.5VDC, IP67, RC2-RC3-RC4-RC5 zones

WSSFC-AG-8-01

Sigfox XYZ Tilt sensor, Internal antenna, Type AA battery 1.5VDC, IP67, RC1-RC6-RC7 zones

0. Configuration Check List

STEP 1: Select RC

1. Select RC zone using Modbus Configuration Cable

RC zones selection 1, 2, 4 is RCZ1, RCZ2, RCZ4  (refer to register address 270)

2. Select RC zone using button

Refer to the button configuration

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section using the Modbus Configuration Cable

STEP 4:  Add device to Backend Sigfox

refer to section 5.4 for details

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.0

1.02

DEC-2020

2. Introduction

WSSFC-AG is a Sigfox Tilt Sensor, can be used to measure 3 tilt angles X, Y, Z of any object as Tower, Building, Tree, Electricity Tower, Telecom Tower, Bridges... The Tilt sensor utilises the combination of advanced Accelerometer and Gyro meter to deliver high accuracy and stable measurement of Tilt angle of 03 axis X,Y,Z. The Ultra-Low Power Power design and smart firmware allow the sensor to last up to 10 years with 02 x AA battery (depending on configuration). The sensor will transmit data in kilo-meters distance to Sigfox basestation. WSSFC-AG can support all regions of Sigfox network in over the World, RC1, RC2, RC3, RC4, RC5, RC6, RC7.

3. Specification

SENSORS SPECIFICATION:

Tilt Sensor

Built-in advanced accelerometer and gyro meter to deliver tilt angle measurement of X, Y, Z

Measurement range

± 90° of XYZ

Repeatibility

± 0.25°

Sensor sampling rate

1Hz max

Alarm setting

setting the alarm threshold for each angle

Sigfox SPECIFICATION:

Sigfox zones

select RC2-RC3-RC4-RC5 or RC1-RC6-RC7

Antenna

Internal Antenna 2dbi

Battery

02 x AA Type 1.5VDC, working time up to 10 years (depends on configuration)

RF Module complies to

CE, FCC, ARIB

Working temperature

-40°C..+60°C (using Energizer Lithium Ultimate AA battery)

Dimensions

H97xW73xD42

Net-weight

250 grams

Housing

Polycarbonate & POM plastic, IP67

4. Dimensions

5. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol)

After 1 minute 30 seconds later the device will send the first data packet and at the same time wait for the downlink packet from the Base Station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent.

REED SWITCHS FUNCTIONS (activated by magnet):

EVENT

PRE-CONDITION

ACTION

LED STATUS

ACTIVITIES

POST-CONDITION

FORCE_DATA

Any state

Move Magnet Key to contact point of REED SWITCH.Led blink SKY BLUE, move Magnet Key away.

Blink SKY BLUE

See FW specs

Back to previous state

PARAMETERS_UPDATE

Any state

Move Magnet Key to contact point of REED SWITCH.Led blink SKY BLUE, hold Magnet Key 5s.Led blink PURPLE, move Magnet Key away.

Blink PURPLE

See FW specs

Back to previous state

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 5s. if shorter than 5s, there will be no data sending.

5.1 LED meaning

Whenever the data is sent to base station, the LED will lit with color codes as below:

RC1: RED colour

RC2: GREEN colour

RC4: BLUE colour

5.2 Button Function

the push button can only be used for the first 60 seconds after powering up.

5.2.1 Menu configuration

There are 3 configuration menus: tx_repeat, downlink_flag, radio configuration.

We use the button to enter the menus as follows:

5.2.1.1 tx_repeat

Press and hold the button 2s  ->  When the Red LED is on, it means entering the tx_repeat configuration menu. Then release to configure it.

Press to configure. After pressing if the Red LED flashes once, tx_repeat = 0 (send 1 time). After pressing if the Red LED blinks twice, it is tx_repeat = 1 (send 3 times).

5.2.1.2 downlink_flag

Press and hold the button 5s  ->  When the Green LED is on, it means entering the downlink_flag configuration menu. Then release to configure it.

Press to configure. After pressing if the Green LED flashes once, it is downlink_flag = 0 (downlink is not allowed). After pressing if the Red LED blinks twice, it is downlink_flag = 1 (downlink is allowed).

5.2.1.3 radio configuration

Press and hold the button 10s  ->  Blue LED is on, it means entering the Radio Configuration menu. Then release to configure it.

Press to configure. After pressing if the Blue LED blinks once, it is Radio Configuration = 1. After pressing if the Blue LED flashes twice, it is Radio Configuration = 2. After pressing if the Blue LED flashes 4 times, it is Radio Configuration = 4.

5.2.2 Exit the menu:

There are 3 ways to exit the menu:

Press and hold for 3s, the LED turns off to exit the menu;

Wait 30 seconds, then exit the menu;

Take out the battery, it all starts over (outside the menu)).

5.3 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC4

Uplink center frequency (MHz)

868.130

902.200

920.800

Downlink center frequency (MHz)

869.525

905.200

922.300

Uplink data rate (bit/s)

100

600

600

Downlink data rate (bit/s)

600

600

600

Sigfox recommended EIRP (dBm)

16

24

24

Specifics

Duty cycle 1% *

Frequency hopping **

Frequency hopping **

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

5.4 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

5.5 Measurement principle of Sigfox Sensor

When the sensor sampling time interval is reached, for example 2 minutes, the Sigfox node will wake up and switch ON the power supply to supply the energy to external sensor to start the measurement. Depends on the type and characteristic of external sensor, the sensor will take a certain time to finish the measurement.

Once reading the value, it can be scaled to any engineering value by the following formula:

Y = aX + b

Where:

X: the raw value from sensor

Y: the calculated value will be sent to Sigfox base station in the payload data.

a: constant (default value is 1)

b: constant (default value is 0)

So, if there is no user setting for a and b ==> Y = X

The Y value will be compared with Lo and Hi threshold. Please refer below the graph of alarm processing.

5.6 Configuration Parameters

Parameter

Description

Possible values

Default value 

Length (in bits)

LED_BUZZER_ENABLE

Enable/Disable LEDs and Buzzersinteractions for action not triggered by the reed switch

0b0 = LEDs and Buzzers are OFF0b1 = LEDs and Buzzers are ON

0b1 = LEDs and Buzzers are ON

1

HEARTBEAT_PERIOD

Period of time to send HEARTBEAT event

0b000 = every  1h0b001 = every  6h0b010 = every 12h0b011 = every 24h (1 day)0b100 = every 48h (2 days)0b101 = every 72h (3 days)0b110 = every 120h (5 days)0b111 = every 240h (10 days)

0b011 = every 24h (1 day)

3

MEASURE_PERIOD

Period of time to measuresensor

0b0000 = every 1s0b0001 = every 2s0b0010 = every 5s0b0011 = every 10s0b0100 = every 20s0b0101 = every 30s0b0110 = every 1min0b0111 = every 2min0b1000 = every 5min0b1001 = every 10min0b1010 = every 20min0b1011 = every 30min0b1100 = every 1h0b1101 = every 2h0b1110 = every 3h0b1111 = every 6h

0b1001 = every 10min

4

TX_REPEAT

Sigfox TX repeat

0b0 = Send RF 1 time0b1 = Send RF 3 time

0b1 = Send RF 3 time

1

CYCLIC_DATA_PERIOD

Period of time to send CYCLIC_DATA event

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b000 = every  10min

3

DEVICE_RESET

Once this parameter is set, the device shall restart once after having received the Downlink.

0b1010 = 0xA = force device resetothers = do nothing

0b0000 = do nothing

4

DOWNLINK_TYPE

Downlink type

4-bit unsigned integerSee Sigfox Downlink tab

0b0000

4

5.7 Payload Data

The following is the format of payload data that will be sent to the Sigfox server.

5.7.1 Payload Fields

Data name

Description

Encoding or Possible values

Length (in bits)

EVENT_ID

Unique ID identifying the device event

4-bit unsigned integer0 = START_UP1 = HEARTBEAT2 = PARAMETERS_UPDATE3 = FORCE_DATA4 = CYCLIC_DATA5 = ALARM

4

HW_VERSION

Indicate HW  version

4-bit unsigned integer1..15

4

FW_VERSION

Indicate FW version

8-bit unsigned integer1..255

8

LATEST_SIGFOX_DOWNLINK

Latest received and valid sigfox downlink frame= Current configuration

64-bit encoded fieldSee Sigfox Downlink tab

64

HW_ERROR

HW error

0b0 = no error0b1 = error

1

BATTERY_LEVEL

Battery level

2-bit unsigned integer0..3

2

X_TILT_VALUE_X10

X Tilt value

16-bit signed integerX_TILT_VALUE = X_TILT_VALUE_X10 / 10Range: -90.0 to 90.0

16

Y_TILT_VALUE_X10

Y Tilt value

16-bit signed integerY_TILT_VALUE = Y_TILT_VALUE_X10 / 10Range: -90.0 to 90.0

16

Z_TILT_VALUE_X10

Z Tilt value

16-bit signed integerZ_TILT_VALUE = Z_TILT_VALUE_X10 / 10Range: -90.0 to 90.0

16

5.7.2 Sigfox Uplink Frame Format

Size

START_UP

(led blink WHITE)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

10.0

bits

4

4

8

64

Value

0b0000 = 0

yes

yes

yes

HEARTBEAT

(led blink GREEN)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

10.0

bits

4

4

8

64

Value

0b0001 = 1

yes

yes

yes

PARAMETERS_UPDATE

(led blink PURPLE)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

10.0

bits

4

4

8

64

Value

0b0010 = 2

yes

yes

yes

FORCE_DATA

(led blink SKY BLUE)

Payload

EVENT_ID

HW_ERROR

reserved

BATTERY_LEVEL

reserved

X_TILT_VALUE_X10

Y_TILT_VALUE_X10

Z_TILT_VALUE_X10

8.0

bits

4

1

5

2

4

16

16

16

Value

0b0011 = 3

yes

zeros

yes

zeros

yes

yes

yes

CYCLIC_DATA

(led blink SKY BLUE)

Payload

EVENT_ID

HW_ERROR

reserved

BATTERY_LEVEL

reserved

X_TILT_VALUE_X10

Y_TILT_VALUE_X10

Z_TILT_VALUE_X10

8.0

bits

4

1

5

2

4

16

16

16

Value

0b0100 = 4

yes

zeros

yes

zeros

yes

yes

yes

5.7.3 Payload for Downlink, length is 8 bytes.

The Sigfox node is only able to receive max 04 downlinks a day, each downlink will be waiting in every 06 hours.

User can set the down link data in Sigfox back-end system in advance, whenever the Sigfox node connected to base stations and with downlink waiting is enable at that time (one time in 6 hours), the downlink data will be loaded to Sigfox node.

The downlink data can be any configuration parameter.

Please pay attention when send downlink data. If there was a mistake in sending wrong data, it would cause the Sigfox node not working properly and user need to configure it by offline cable!!!

Size

DOWNLINK_TYPE = 0

Payload

reserved

LED_BUZZER_ENABLE

HEARTBEAT_PERIOD

MEASURE_PERIOD

TX_ REPEAT

CYCLIC_DATA_PERIOD

DEVICE_RESET

DOWNLINK_TYPE

8.0

bits

44

1

3

4

1

3

4

4

Value

zeros

yes

yes

yes

yes

yes

yes

0b0000 = 0

DOWNLINK_TYPE = 5

Payload

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

reserved

DOWNLINK_TYPE

8.0

bits

8

8

16

28

4

Value

yes

0x02 = 2

yes

zeros

0b0101 = 5

Payload

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

reserved

DOWNLINK_TYPE

8.0

bits

8

8

32

12

4

Value

yes

0x04 = 4

yes

zeros

0b0101 = 5

6. Offline configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=qK0PGNbY1g1fuxTqbFW9SXtEvCw7bpc6

How to use the Modbus configuration software

Step 2: Plug the configuration cable to Computer via USB port;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-AG.csv

Here is the table of Data will be read by Modbus tool

Modbus Register (Dec)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

# of Registers

Description

Range

Default

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Here is the table for Configuration:

Modbus Register (Dec)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read / Write

274

112

3

16

1

SERVER_CONFIG

uint16

Read / Write

0: Send to Sigfox Network1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1, 2, 4

4

uint16

Read / Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

277

115

3

16

1

TX_POWER

20

int16

Read / Write

RF Tx power

286

11E

3

16

2

SENSOR_BOOT_TIME

200

uint32

Read / Write

Boot time of sensor/input, in ms

7. Installation

7.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

7.2 Process mounting

7.2.1 Bracket installation

7.2.2 Site Installation

WARNING:

The sensor must be securely fixed on the tilt angle measurement area.

The sensor only measures 3 axes from -90 degrees to 90 degrees

It is recommended to make a standard angle of 90 degrees for the sensor to achieve the best measurement results

7.3 Battery installation

Steps for battery installation:

Step 1: Using L hex key to unscrew M4 screws at the side of the housing and carefully pull out the top plastic housing in the vertical direction

Step 2: Insert 02 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing and locking by L hex key

ATTENTION:When reinstalling the cover, pay attention to put the PCB edge into the middle slot of the box inside as shown below)

8. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply or battery ran out

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Or place the Magnet key not right position

Locate the correct position for magnet key

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages of uplink per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

Contact manufacturer

6

The measurement values from sensor do not change, keep constant values for long time

Sensor got failure

Sensor cable broken

Sensor connector is not connected firmly

Check sensor cable and connector

If the issue is still exist, please contact manufacturer for warranty or replace new sensor

7

The node does not send RF and the RF module is hot

Insert the battery in the wrong direction

Electronics got problem

Check battery polarity

8

RSSI is weak and often loses data

Distance between Node and Base station is far or there are many obstructions

Connection to Antenna problem

Check location of Sigfox node and distance to base station

Check the antenna connector in the PCB

9. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

USER GUIDE FOR SIGFOX-READY PRECISION FUEL LEVEL SENSOR WSSFC-CAP10

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC-CAP10-MN-EN-01

FEB-2022

This document is applied for the following products

SKU

WSSFC-G4F-NH3

HW Ver.

1.1

FW Ver.

1.0

Item Code

WSSFC-CAP10-8-1500

SIGFOX HIGH PRECISION CAPACITANCE FUEL LEVEL SENSOR FOR DIESEL OIL, VEGETABLE OIL, LUBRICANT, 1500MM, FIELD CUTTABLE, INTERNAL ANTENNA, TYPE AA BATTERY 1.5VDC, IP67, RC1 ZONE

WSSFC-CAP10-9-1500

SIGFOX HIGH PRECISION CAPACITANCE FUEL LEVEL SENSOR FOR DIESEL OIL, VEGETABLE OIL, LUBRICANT, 1500MM, FIELD CUTTABLE, INTERNAL ANTENNA, TYPE AA BATTERY 1.5VDC, IP67, RC2-RC4 ZONES

CAP10PROEXT0700

CAP10 PROBE EXTENSION LENGTH 700 MM

CAP10PROEXT1000

CAP10 PROBE EXTENSION LENGTH 1000 MM

CAP10PROEXT1500

CAP10 PROBE EXTENSION LENGTH 1500 MM

0. Configuration Check List

0.1 Configuration Sigfox Sensor

STEP 1: Select RC

1. Select RC zone

RC zones selection 1, 2, 4,... is RCZ1, RCZ2, RCZ4,...  (refer to section 6)

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section 6

STEP 4:  Add device to Backend Sigfox

refer to section 6.2 for details

STEP 5:  Installation

refer to section 9 for details

0.2 Setup Fuel Sensor

Default communication of CAP10CNR RS485:

Baudrate : 19200Data bit : 8Stop bit : 1Parity : NoneModbus Slave address : 30

See more how to configure CAP10CNR here

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.1

1.0

DEC-2020

2. Introduction

WSSFC-CAP10 is a Sigfox fuel level sensor that utilizes the 10-year experience of Daviteq in digital capacitance measuring technique. It delivers high accuracy and stability with 0.1% of span. Ultra-low power design and smart firmware allow the complete Wireless and Sensor package to run on 2 x AA battery 1.5V for 2-5 years with 15 minutes updates. It can support the following regions RC1, RC2, & RC4.

Typical Applications: Monitoring fuel level and fuel consumption in fuel tanks of Genset, Boiler, Heavy equipment or machinery...

3. Specification

SENSORS SPECIFICATION:

Measurement Range (mm)

Standard Range: 700, 1000, 1500, can be extended up to 4000

Accuracy / Resolution / Repeatability

±0.1% of Span / 0.1% / ±0.1% of span

Thermal drift

< +0.03% of span per 10oC

Connector

M12 male, 4-pin, Coding A

Sensor MTBF

More than 10 years

Sensor wetted materials

Aluminum and engineering plastic

Operating Temperature Range

-40 to 85 °C

Operating Humidity Range

0-100% RH

Sensor rating

IP67, outdoor

Certification

CE-Marking per EN61236-1 (with test report)

Standard accessories

Filter footer, flange, gasket, o-ring, self-tapping screws

Sigfox SPECIFICATION:

Sigfox zones

select RC1-RC2-RC4

Antenna

Internal Antenna 2 dbi

Configuration

via Downlink or offline USB cable (PC software is supplied at free)

Battery

02 x AA Type 1.5VDC

RF Module complies to

CE, FCC, ARIB

Working temperature

-40°C..+60°C (using Energizer Lithium Ultimate AA battery)

Dimensions and Net-weight

H140xW73xD42, 250 grams (Sigfox Device only)

Housing

Polycarbonate, IP67

Mounting

Wall mount bracket

Sensor cable

2m sensor cable with M12-male connector

4. Dimensions

4.1 Dimensions of the Sigfox sensor

4.2 Dimensions of the Fuel Sensor

5. Scope of delivery

Sigfox Sensor - Bracket

Fuel Sensor

Installation tool

6. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol).

After that, Sigfox node will send the first message to Base station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent.

EVENT

PRE-CONDITION

ACTION

LED STATUS

BUZZER STATUS

ACTIVITIES

POST-CONDITION

FORCE_DATA

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beeps 1 time, move Magnet Key away.

Blink SKY BLUE

Beep 1 time

See FW specs

Back to previous state

PARAMETERS_UPDATE

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beeps 1 time, hold Magnet Key 5s.Buzzer beeps 2 times.

Blink PURPLE

Beep 2 times

See FW specs

Back to previous state

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 15s. if shorter than 15s, there will be no data sending and you will not hear the beep sound.

the push button can only be used for the first 60 seconds after powering up.

6.1 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC3

RC4

RC5

RC6

RC7

Uplink center frequency (MHz)

868.130

902.200

923.200

920.800

923.300

865.200

868.800

Downlink center frequency (MHz)

869.525

905.200

922.200

922.300

922.300

866.300

869.100

Uplink data rate (bit/s)

100

600

100

600

100

100

100

Downlink data rate (bit/s)

600

600

600

600

600

600

600

Sigfox recommended EIRP (dBm)

16

24

16

24

14

16

16

Specifics

Duty cycle 1% *

Frequency hopping **

Listen Before Talk ***

Frequency hopping **

Listen Before Talk ***

Duty cycle 1% *

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

6.2 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

6.3 Measurement principle of Sigfox Sensor

When the sensor sampling time interval is reached, for example 2 minutes, the Sigfox node will wake up and switch ON the power supply to supply the energy to external sensor to start the measurement. Depends on the type and characteristic of external sensor, the sensor will take a certain time to finish the measurement.

Once reading the value, it can be scaled to any engineering value by the following formula:

Y = aX + b

Where:

X: the raw value from sensor

Y: the calculated value will be sent to Sigfox base station in the payload data.

a: constant (default value is 1)

b: constant (default value is 0)

So, if there is no user setting for a and b ==> Y = X

The Y value will be compared with Lo and Hi threshold. Please refer below the graph of alarm processing.

Here is the information about CAP10CNR

6.4 Configuration Parameters

Parameter

Description

Possible values

Default value 

HIGH_ALARM_SETPOINT

High alarm setpoint for calculated value

32-bit float

1000000000

LOW_ALARM_SETPOINT_FACTOR

Low alarm setpoint for calculated value

8-bit unsigned integerLOW_ALARM_SETPOINT = HIGH_ALARM_SETPOINT *  LOW_ALARM_SETPOINT_FACTOR / 200

0

ALARM_ENABLE

Enable/Disable ALARM event

0b0 = ALARM event is OFF0b1 = ALARM event is ON

0b0 = ALARM event is OFF

ALARM_PERIOD

Period of time to send ALARM event

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b000 = every  10min

LED_BUZZER_ENABLE

Enable/Disable LEDs and Buzzersinteractions for action not triggered by the reed switch

0b0 = LEDs and Buzzers are OFF0b1 = LEDs and Buzzers are ON

0b1 = LEDs and Buzzers are ON

HEARTBEAT_PERIOD

Period of time to send HEARTBEAT event

0b000 = every  1h0b001 = every  6h0b010 = every 12h0b011 = every 24h (1 day)0b100 = every 48h (2 days)0b101 = every 72h (3 days)0b110 = every 120h (5 days)0b111 = every 240h (10 days)

0b011 = every 24h (1 day)

MEASURE_PERIOD

Period of time to measuresensor

0b0000 = every 1s0b0001 = every 2s0b0010 = every 5s0b0011 = every 10s0b0100 = every 20s0b0101 = every 30s0b0110 = every 1min0b0111 = every 2min0b1000 = every 5min0b1001 = every 10min0b1010 = every 20min0b1011 = every 30min0b1100 = every 1h0b1101 = every 2h0b1110 = every 3h0b1111 = every 6h

0b1100 = every 1h

TX_REPEAT

Sigfox TX repeat

0b0 = Send RF 1 time0b1 = Send RF 3 time

0b1 = Send RF 3 time

CYCLIC_DATA_PERIOD

Period of time to send CYCLIC_DATA event

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b010 = every 1h

DEVICE_RESET

Once this parameter is set, the device shall restart once after having received the Downlink.

0b1010 = 0xA = force device resetothers = do nothing

0b0000 = do nothing

DOWNLINK_TYPE

Downlink type

4-bit unsigned integerSee Sigfox Downlink tab

0b0000

6.5 Payload Fields

Data name

Description

Encoding or Possible values

Length (in bits)

EVENT_ID

Unique ID identifying the device event

4-bit unsigned integer0 = START_UP1 = HEARTBEAT2 = PARAMETERS_UPDATE3 = FORCE_DATA4 = CYCLIC_DATA5 = ALARM

4

HW_VERSION

Indicate HW  version

4-bit unsigned integer1..15

4

FW_VERSION

Indicate FW version

8-bit unsigned integer1..255

8

LATEST_SIGFOX_DOWNLINK

Latest received and valid sigfox downlink frame= Current configuration

64-bit encoded fieldSee Sigfox Downlink tab

64

HW_ERROR

HW error

0b0 = no error0b1 = error

1

ALARM

Alarm

0b00 = no alarm0b01 = low alarm0b10 = high alarm0b11 = not used

2

BATTERY_LEVEL

Battery level

2-bit unsigned integer0..3

2

RAW_VALUE

Raw value of CAP10-RS485

16-bit unsigned integer

16

SCALED_VALUE

Scaled value of  CAP10-RS485

16-bit signed integer

16

TENTATIVE

Tentative number

8-bit unsigned integerFormula: (8-bit_Tentative +1)= real_tentative #Range: 1 to 256Accuracy: 1Example: 0b00000111 = 0x7=7=> 7+1 =>tentative # 8

8

6.6 Sigfox Uplink Frame Format

Sigfox Frame software for Sigfox Sensor

Size

START_UP

(led blink WHITE)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

10.0

bits

4

4

8

64

Value

0b0000 = 0

yes

yes

yes

HEARTBEAT

(led blink GREEN)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

10.0

bits

4

4

8

64

Value

0b0001 = 1

yes

yes

yes

PARAMETERS_UPDATE

(led blink PURPLE)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

10.0

bits

4

4

8

64

Value

0b0010 = 2

yes

yes

yes

Size

FORCE_DATA

(led blink SKY BLUE)

Payload

EVENT_ID

HW_ ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

SCALED_VALUE

6.0

bits

4

1

3

2

2

4

16

16

Value

0b0011 = 3

yes

zeros

yes

yes

zeros

yes

yes

CYCLIC_DATA

(led blink SKY BLUE)

Payload

EVENT_ID

HW_ ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

SCALED_VALUE

TENTATIVE

7.0

bits

4

1

3

2

2

4

16

16

8

Value

0b0100 = 4

yes

zeros

yes

yes

zeros

yes

yes

yes

ALARM

(led blink RED)

Payload

EVENT_ID

HW_ ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

SCALED_VALUE

TENTATIVE

7.0

bits

4

1

3

2

2

4

16

16

8

Value

0b0101 = 5

yes

zeros

yes

yes

zeros

yes

yes

yes

6.7 Sigfox Downlink Frame Format

Sigfox Frame software for Sigfox Sensor

The Sigfox node is only able to receive max 04 downlinks a day, each downlink will be waiting in every 06 hours.

User can set the down link data in Sigfox back-end system in advance, whenever the Sigfox node connected to base stations and with downlink waiting is enable at that time (one time in 6 hours), the downlink data will be loaded to Sigfox node.

The downlink data can be any configuration parameter.

Please pay attention when send downlink data. If there was a mistake in sending wrong data, it would cause the Sigfox node not working properly and user need to configure it by offline cable!!!

Downlink Frame Format:

Size

DOWNLINK_TYPE = 0

Payload

HIGH_ALARM_SETPOINT

LOW_ALARM_SETPOINT_FACTOR

ALARM_ENABLE

ALARM_PERIOD

LED_BUZZER_ENABLE

 8.0

bits

32

8

1

3

1

Value

yes

yes

yes

yes

yes

HEARTBEAT_PERIOD

MEASURE_PERIOD

TX_REPEAT

CYCLIC_DATA_PERIOD

DEVICE_RESET

DOWNLINK_TYPE

3

4

1

3

4

4

yes

yes

yes

yes

yes

0b0000 = 0

Size

DOWNLINK_TYPE = 5

Payload

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

reserved

DOWNLINK_TYPE

 8.0

bits

8

8

16

28

4

Value

yes

0x02 = 2

yes

zeros

0b0101 = 5

Payload

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

reserved

DOWNLINK_TYPE

 8.0

bits

8

8

32

12

4

Value

yes

0x04 = 4

yes

zeros

0b0101 = 5

7. Modbus Memmap

7.1 Data table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

7.2 Configuration table

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

274

112

3

16

1

SERVER_CONFIG

uint16

Read/Write

0: Send to Sigfox Network1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1, 2, 4

4

uint16

Read/Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

0.06666

float

Read/Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

-1,113.33

float

Read/Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1E+09

float

Read/Write

High cut value for calculated value

284

11C

3

16

2

LOW_CUT

0

float

Read/Write

Low cut value for calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

800

uint32

Read/Write

Boot time of sensor/input, in ms

306

132

3

16

1

CAP10_BAUD_RATE

0-1

1

uint16

Read/Write

0: 9600, 1:19200

307

133

3

16

1

CAP10_NUM_OF_SAMPLES

1-20

2

uint16

Read/Write

Number of cap10 sensor reading samples to get average

8. Offline configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=yDOjE5d6kqFlGNVVlMdFg19Aad6aw0Hs

How to use the Modbus configuration software

Step 2: Plug the configuration cable to Computer via USB port;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX CAP10 SENSOR FW1.0.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR WSSFC-CAP10

9. Installation

9.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

9.2 Mounting

9.2.1 Bracket installation

9.2.2 Site installation

WARNING: The sensor must be securely fixed near the measuring area.

Sigfox sensor connected to fuel sensor via M12 . connection cable

Default communication of CAP10CNR RS485:

Baudrate : 19200Data bit : 8Stop bit : 1Parity : NoneModbus Slave address : 30

Refer here for installation instructions for cap10

9.3 Battery installation

Steps for battery installation:

Step 1: Open the cover by using flat head screwdriver

Step 2: Insert 02 x AA 1.5VDC battery, please take note the poles of the battery

ATTENTION:REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 3: Insert the top plastic housing and locking by L hex key

ATTENTION: When reinstalling the cover, pay attention to put the PCB edge into the middle slot of the box inside as shown below)

10. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply or battery ran out

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Or place the Magnet key not right position

Locate the correct position for magnet key

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages of uplink per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

Contact manufacturer

6

The measurement values from sensor do not change, keep constant values for long time

Sensor got failure

Sensor cable broken

Sensor connector is not connected firmly

Check sensor cable and connector

If the issue is still exist, please contact manufacturer for warranty or replace new sensor

7

The node does not send RF and the RF module is hot

Insert the battery in the wrong direction

Electronics got problem

Check battery polarity

8

RSSI is weak and often loses data

Distance between Node and Base station is far or there are many obstructions

Connection to Antenna problem

Check location of Sigfox node and distance to base station

Check the antenna connector in the PCB

11. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

USER GUIDE FOR SIGFOX NODE PROCESS PRESSURE SENSOR WSSFC-PPS

WSSFC-PPS -MN-EN-01

SEP-2020

This document is applied for the following products

SKU

WSSFC-PPS

HW Ver.

1.2

FW Ver.

1.2

Item Code

WSSFC-PPS-9-10

Sigfox Node Gage Process Pressure Sensor, Internal antenna, range 0-10 barg, accuracy 0.5%, process connection G1/4-male, 304SS, Type AA battery 1.5VDC, IP67, RC2-RC3-RC4-RC5 zones

WSSFC-PPS-8-10

Sigfox Node Gage Process Pressure Sensor, Internal antenna, range 0-10 barg, accuracy 0.5%, process connection G1/4-male, 304SS, Type AA battery 1.5VDC, IP67, RC1-RC6-RC7 zones

0. Configuration Check List

STEP 1: Select RC

1. Select RC zone

RC zones selection 1, 2, 4,... is RCZ1, RCZ2, RCZ4,...  (refer to section 5)

STEP 2:  Check ID and PAC

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section 5

STEP 4:  Add device to Backend Sigfox

refer to section 5.4 for details

STEP 5:  Installation

refer to section 7  for details

1. Change Log

Document Ver.

Release Date

Change log

1.0

SEP-2020

- First version for WSSFC-PPS

1.1

FEB-2022

- Update information

2. Introduction

WSSFC-PPS is a Sigfox node integrated Process Pressure Sensor, and it has different kinds of measurements, such as Gage/Absolute/Sealed Gage, range -1 .. + 700 bar, high accuracy, and stability. The sensor will transmit data in kilo-meters distance to Sigfox basestation. WSSFC-PPS can support all regions of Sigfox network in over the World, RC1, RC2, RC3, RC4, RC5, RC6, RC7.

3. Specification

SENSORS SPECIFICATION:

Sensor

Advanced PIEZO technology

Measurement range

Select from -1 .. + 700 bar Gage/Absolute/Sealed Gage

Over pressure protection

1.5 x Span

Accuracy & Stability

0.5% of span, < 0.3% span/year

Wetted parts

304SS/316SS

Measuring Fluids

Any fluid which is workable with materials 304SS/316SS

Working temperature

-10 .. + 80 oC

Process connection

Standard G1/4 or Others (consult factory)

Sigfox SPECIFICATION:

Sigfox zones

select RC2-RC3-RC4-RC5 or RC1-RC6-RC7

Antenna

Internal Antenna 2dbi

Battery

02 x AA Type 1.5VDC, working time up to 10 years (depends on configuration)

RF Module complies to

CE, FCC, ARIB

Working temperature

-40oC..+60oC (using Energizer Lithium Ultimate AA battery)

Dimensions

H180xW50xD40

Net-weight

250 grams

Housing

Polycarbonate & POM plastic, IP67

4. Dimensions

5. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol)

After 1 minute 30 seconds later the device will send the first data packet and at the same time wait for the downlink packet from the Base Station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent. (Buzzer will be updated in the latest version)

EVENT

PRE-CONDITION

ACTION

LED STATUS

BUZZER STATUS

ACTIVITIES

POST-CONDITION

FORCE_DATA

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beep 1 time, move Magnet Key away.

Blink SKY BLUE

Beep 1 time

See FW specs

Back to previous state

PARAMETERS_UPDATE

Any state

Move Magnet Key to contact point of REED SWITCH.Buzzer beep 1 time, hold Magnet Key 5s.Buzzer beep 2 times.

Blink PURPLE

Beep 2 times

See FW specs

Back to previous state

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 15s. if shorter than 15s, there will be no data sending.

5.1 LED meaning

Whenever the data is sent to base station, the LED will lit with color codes as below:

RC1: RED colour

RC2: GREEN colour

RC4: BLUE colour

5.2 Button Function

5.2.1 Menu configuration

There are 3 configuration menus: tx_repeat, downlink_flag, radio configuration.

We use the button to enter the menus as follows:

5.2.1.1 tx_repeat

Press and hold the button 2s  ->  When the Red LED is on, it means entering the tx_repeat configuration menu. Then release to configure it.

Press to configure. After pressing if the Red LED flashes once, tx_repeat = 0 (send 1 time). After pressing if the Red LED blinks twice, it is tx_repeat = 1 (send 3 times).

5.2.1.2 downlink_flag

Press and hold the button 5s  ->  When the Green LED is on, it means entering the downlink_flag configuration menu. Then release to configure it.

Press to configure. After pressing if the Green LED flashes once, it is downlink_flag = 0 (downlink is not allowed). After pressing if the Red LED blinks twice, it is downlink_flag = 1 (downlink is allowed).

5.2.1.3 radio configuration

Press and hold the button 10s  ->  Blue LED is on, it means entering the Radio Configuration menu. Then release to configure it.

Press to configure. After pressing if the Blue LED blinks once, it is Radio Configuration = 1. After pressing if the Blue LED flashes twice, it is Radio Configuration = 2. After pressing if the Blue LED flashes 4 times, it is Radio Configuration = 4.

5.2.2 Exit the menu:

There are 3 ways to exit the menu:

Press and hold for 3s, the LED turns off to exit the menu;

Wait 30 seconds, then exit the menu;

Take out the battery, it all starts over (outside the menu)).

5.3 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC4

Uplink center frequency (MHz)

868.130

902.200

920.800

Downlink center frequency (MHz)

869.525

905.200

922.300

Uplink data rate (bit/s)

100

600

600

Downlink data rate (bit/s)

600

600

600

Sigfox recommended EIRP (dBm)

16

24

24

Specifics

Duty cycle 1% *

Frequency hopping **

Frequency hopping **

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

5.4 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

5.5 Process of measurement

When the sensor sampling time interval is reached, for example 2 minutes, the Sigfox node will wake up and switch ON the power supply to supply the energy to external sensor to start the measurement. Depends on the type and characteristic of external sensor, the sensor will take a certain time to finish the measurement.

Once reading the value, it can be scaled to any engineering value by the following formula:

Y = aX + b

Where:

X: the raw value from sensor

Y: the calculated value will be sent to Sigfox base station in the payload data.

a: constant (default value is 1)

b: constant (default value is 0)

So, if there is no user setting for a and b ==> Y = X

The Y value will be compared with Lo and Hi threshold. Please refer below the graph of alarm processing.

​

5.6 Configuration Parameters

Parameter

Description

Possible values

Default value 

Length (in bits)

HIGH_ALARM_SETPOINT

High alarm setpoint for calculated value

32-bit float

1000000000

32

LOW_ALARM_SETPOINT_FACTOR

Low alarm setpoint for calculated value

8-bit unsigned integerLOW_ALARM_SETPOINT = HIGH_ALARM_SETPOINT *  LOW_ALARM_SETPOINT_FACTOR / 200

0

8

ALARM_ENABLE

Enable/Disable ALARM event

0b0 = ALARM event is OFF0b1 = ALARM event is ON

0b0 = ALARM event is OFF

1

ALARM_PERIOD

Period of time to send ALARM event

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b000 = every  10min

3

LED_BUZZER_ENABLE

Enable/Disable LEDs and Buzzersinteractions for action not triggered by the reed switch

0b1 = LEDs and Buzzers are ON

1

HEARTBEAT_PERIOD

Period of time to send HEARTBEAT event

0b000 = every  1h0b001 = every  6h0b010 = every 12h0b011 = every 24h (1 day)0b100 = every 48h (2 days)0b101 = every 72h (3 days)0b110 = every 120h (5 days)0b111 = every 240h (10 days)

0b011 = every 24h (1 day)

3

MEASURE_PERIOD

Period of time to measuresensor

0b0000 = every 1s0b0001 = every 2s0b0010 = every 5s0b0011 = every 10s0b0100 = every 20s0b0101 = every 30s0b0110 = every 1min0b0111 = every 2min0b1000 = every 5min0b1001 = every 10min0b1010 = every 20min0b1011 = every 30min0b1100 = every 1h0b1101 = every 2h0b1110 = every 3h0b1111 = every 6h

0b1001 = every 10min

4

TX_REPEAT

Sigfox TX repeat

0b0 = Send RF 1 time0b1 = Send RF 3 time

0b1 = Send RF 3 time

1

CYCLIC_DATA_PERIOD

Period of time to send CYCLIC_DATA event

0b000 = every  10min0b001 = every  30min0b010 = every 1h0b011 = every 2h0b100 = every 3h0b101 = every 6h0b110 = every 12h0b111 = every 24h

0b001 = every  30min

3

DEVICE_RESET

Once this parameter is set, the device shall restart once after having received the Downlink.

0b1010 = 0xA = force device resetothers = do nothing

0b0000 = do nothing

4

DOWNLINK_TYPE

Downlink type

4-bit unsigned integerSee Sigfox Downlink tab

0b0000

4

5.7 Payload Data

The following is the format of payload data will be sent to Sigfox server. Length is 6 bytes, it is future-proof for expansion to 12 bytes.

5.7.1 Payload Fields

Data name

Description

Encoding or Possible values

Length (in bits)

EVENT_ID

Unique ID identifying the device event

4-bit unsigned integer0 = START_UP1 = HEARTBEAT2 = PARAMETERS_UPDATE3 = FORCE_DATA4 = CYCLIC_DATA5 = ALARM

4

HW_VERSION

Indicate HW  version

4-bit unsigned integer1..15

4

FW_VERSION

Indicate FW version

8-bit unsigned integer1..255

8

LATEST_SIGFOX_DOWNLINK

Latest received and valid sigfox downlink frame= Current configuration

64-bit encoded fieldSee Sigfox Downlink tab

64

HW_ERROR

HW error

0b0 = no error0b1 = error

1

ALARM

Alarm

0b00 = no alarm0b01 = low alarm0b10 = high alarm0b11 = not used

2

BATTERY_LEVEL

Battery level

2-bit unsigned integer0..3

2

RAW_VALUE

Raw value of pressure sensor (12-bit)

16-bit unsigned integer

16

PRESSURE

Scaled value of pressure sensor

32-bit float

32

TENTATIVE

Tentative number

8-bit unsigned integerFormula: (8-bit_Tentative +1)= real_tentative #Range: 1 to 256Accuracy: 1Example: 0b00000111 = 0x7=7=> 7+1 =>tentative # 8

8

5.7.2 Sigfox Uplink Frame Format

Size

START_UP

(led blink WHITE)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

 10.0

bits

4

4

8

64

Value

0b0000 = 0

yes

yes

yes

HEARTBEAT

(led blink GREEN)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

 10.0

bits

4

4

8

64

Value

0b0001 = 1

yes

yes

yes

PARAMETERS_UPDATE

(led blink PURPLE)

Payload

EVENT_ID

HW_VERSION

FW_VERSION

LATEST_SIGFOX_DOWNLINK

 10.0

bits

4

4

8

64

Value

0b0010 = 2

yes

yes

yes

FORCE_DATA

(led blink SKY BLUE)

Payload

EVENT_ID

HW_ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

PRESSURE

 8.0

bits

4

1

3

2

2

4

16

32

Value

0b0011 = 3

yes

zeros

yes

yes

zeros

yes

yes

CYCLIC_DATA

(led blink SKY BLUE)

Payload

EVENT_ID

HW_ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

PRESSURE

 9.0

bits

4

1

3

2

2

4

16

32

Value

0b0100 = 4

yes

zeros

yes

yes

zeros

yes

yes

ALARM

(led blink RED)

Payload

EVENT_ID

HW_ERROR

reserved

ALARM

BATTERY_LEVEL

reserved

RAW_VALUE

PRESSURE

 9.0

bits

4

1

3

2

2

4

16

32

Value

0b0101 = 5

yes

zeros

yes

yes

zeros

yes

yes

5.7.3 Payload for Downlink, length is 8 bytes.

The Sigfox node is only able to receive max 04 downlinks a day, each downlink will be waiting in every 06 hours.

User can set the down link data in Sigfox back-end system in advance, whenever the Sigfox node connected to base stations and with downlink waiting is enable at that time (one time in 6 hours), the downlink data will be loaded to Sigfox node.

The downlink data can be any configuration parameter.

Please pay attention when send downlink data. If there was a mistake in sending wrong data, it would cause the Sigfox node not working properly and user need to configure it by offline cable!!!

Size

DOWNLINK_TYPE = 0

Payload

HIGH_ALARM_SETPOINT

LOW_ALARM_SETPOINT_FACTOR

ALARM_ENABLE

ALARM_PERIOD

LED_BUZZER_ENABLE

HEARTBEAT_PERIOD

 8.0

bits

32

8

1

3

1

3

Value

yes

yes

yes

yes

yes

yes

MEASURE_PERIOD

TX_REPEAT

CYCLIC_DATA_PERIOD

DEVICE_RESET

DOWNLINK_TYPE

4

1

3

4

4

yes

yes

yes

yes

0b0000 = 0

Size

DOWNLINK_TYPE = 5

Payload

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

reserved

DOWNLINK_TYPE

 8.0

bits

8

8

16

28

4

Value

yes

0x02 = 2

yes

zeros

0b0101 = 5

Payload

PRM_ADDRESS

PRM_LENGTH

PRM_VALUE

reserved

DOWNLINK_TYPE

 8.0

bits

8

8

32

12

4

Value

yes

0x04 = 4

yes

zeros

0b0101 = 5

6. Configuration

DANGER:DO NOT OPEN THE COVER AT HAZARDOUS LOCATION!ONLY OPEN COVER FOR TROUBLE SHOOTING AND CONFIGURATION IN SAFE AREA!

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=qK0PGNbY1g1fuxTqbFW9SXtEvCw7bpc6

How to use the Modbus configuration software

Step 2: Plug the configuration cable to computer via USB port and install the driver;

Step 3: Open the housing;

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX FW1.9.3.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-PPS.csv

Here is the table of Data will be read by Modbus tool

Modbus Register (DEC)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

2

2

3

4

FW_VERSION

string

Read

6

6

3

2

HW_VERSION

string

Read

8

8

3

2

DEVICE_ID

hex

Read

Product ID

10

A

3

4

DEVICE_PAC

hex

Read

Product PAC

14

E

3

1

SENSOR_TYPE

1-255

uint16

Read

Sensor or Input Type

Here is the table for Configuration:

Modbus Register (DEC)

Modbus Register (Hex)

Function Code (Read)

Function Code (Write)

No. of Registers

Description

Range

Default

Format

Property

Comment

270

10E

3

16

4

CURRENT_CONFIGURATION

hex

Read/Write

274

112

3

16

1

SERVER_CONFIG

uint16

Read/Write

0: Send to Sigfox Network1: Send to Dongle

276

114

3

16

1

RADIO_CONFIG

1, 2, 4

4

uint16

Read/Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

277

115

3

16

1

TX_POWER

20

int16

Read/Write

RF Tx power

278

116

3

16

2

CONSTANT_A

1

float

Read/Write

Constant a for scaling measured value

280

118

3

16

2

CONSTANT_B

0

float

Read/Write

Constant b for scaling measured value

282

11A

3

16

2

HIGH_CUT

1000000000

float

Read/Write

High cut value for calculated value

284

11C

3

16

2

LOW_CUT

-1000000000

float

Read/Write

Low cut value for calculated value

286

11E

3

16

2

SENSOR_BOOT_TIME

200

uint32

Read/Write

Boot time of sensor/input, in ms

7. Installation

7.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

7.2 Process mounting

WARNINGS:1. Please make sure the fluid is suitable with the wetted materials of the sensor. Please refer sensor specification;2. Please make sure the operating temperature and pressure is suitable with the sensor. Please refer sensor specification;3. Prepare the professional tools for installation. The inappropriate tools may cause damage to the sensor.

DANGER:1. The installer need to be equipped with full Safety gears during installation, such as safety glasses, safety shoes, safety cloths, safety mask...Please follow the safety instructions of the installation site;2. The installer must be qualified for this installation job;3. The installer must be permitted by Site's owner for performing the installation;

Consider to use the isolation valve 1/2" or 1/4" to isolate the media and the sensor during maintenance;

Fully closing the isolation valve during installation and maintenance the sensor;

Fully open the isolation valve during normal operation;

There are two ways of process mounting as below.

7.2.1 Mounting direct on Pipe

The total weight of the sensor MUST be within the permitted load of the pipe to be installed;

Consider to build the support for the pipe if the sensor weight is larger than the permit;

Below picture shown without the isolation valve, but we highly recommend to use isolation valve.

7.2.2 Remote mounting on wall or pole

Make sure the wall or place of pole for mounting is not covered or affected by the surrounding metallic objects;

Using the metal tubing and fittings for interconnection between process pipe and sensor process connector;

The metal tubing and fitting materials, and size must be sizing properly to suit the process conditions;

It is better to install the isolation valve next to sensor process connector.

7.3 Battery installation

Step 1: Using L hex key to unscrew M4 screws at the side of the housing and carefully pull out the top plastic housing in the vertical direction

Step 2: Insert the type AA battery, please take note the polarity of battery

ATTENTION: REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT!!!

Step 4: Insert the top plastic housing and locking by L hex key

ATTENTION:When reinstalling the cover, pay attention to put the PCB edge into the middle slot of the box inside as shown below)

8. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

LED welding is not good

Check LED condition and LED weld

6

The value of the sensor is 0

No pressure

Lost connection with the sensor

Check pipe pressure

Check sensor connection

7

The node does not send RF and the RF module is hot

Insert the battery in the opposite direction

Short circuit

Warranty or replacement

8

RSSI is weak and often loses data

Distance between Node and Gateway is far or there are many obstructions

Connection to Antenna problem

Check Antenna position

Install Node in a well ventilated location

9. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

USER GUIDE FOR SIGFOX ULTRASONIC LEVEL SENSOR FOR TRASH BIN WSSFC-ULA

THIS IS OBSOLETE MANUAL

Please access https://www.iot.daviteq.com/wireless-sensors for updated manual

WSSFC-ULA -MN-EN-01

DEC-2020

This document is applied for the following products

SKU

WSSFC-ULA

HW Ver.

1.1

FW Ver.

1.0

Item Code

WSSFC-ULA-8-01

Sigfox Ultrasonic Level Sensor for Trash bin, Internal antenna, 4500mm range, Type AA battery 1.5VDC, IP67, RC1 zone

WSSFC-ULA-9-01

Sigfox Ultrasonic Level Sensor for Trash bin, Internal antenna, 4500mm range, Type AA battery 1.5VDC, IP67, RC2-RC4 zones

0. Configuration Check List

Step 1: Overview check

Check cope of delivery

Make sure the device shows no signs of damage

Refer to section 5 for details

STEP 1: Select RC

1. Select RC zone using Modbus Configuration Cable

RC zones selection 1, 2, 4 is RCZ1, RCZ2, RCZ4  (refer to register address 270)

2. Select RC zone

Refer here

Use Modbus Configuration Cable to read the ID and PAC values

Refer to register address 8 and 10 (DEC)

STEP 3:  Configure the sensor's operating parameters

Configure parameters like cycle send data, alarm, a, b,...

Refer to the configuration section using the Modbus Configuration Cable

STEP 4:  Add device to Backend Sigfox

refer to section 5.4 for details

1. Functions Change Log

HW Ver.

FW Ver.

Release Date

Functions Change

1.1

1.0

DEC-2020

2. Introduction

The WSSFC-ULA is a Sub-GHz wireless sensor that uses ultrasonic technology to measure trash bin levels. With advanced digital signal processing technology, the sensor can eliminate unwanted reflected ultrasonic waves. The sensor can be used for trash cans with openable lids where the measured value is not affected during the opening and closing. The sensor is designed for IP68 Standard, which can be used both indoors and outdoors. With Ultra-low Power design and smart firmware allow the sensor can last up to 10 years with 02 x AA-type batteries (depends on configuration). WSSFC-ULA can support all regions of Sigfox network in over the World, RC1, RC2, RC4.The sensor is used to monitor the level of garbage in the trash cans in Office buildings, Hospitals, Schools, Factories... and also for public trash cans of Smart City.

3. Specification

Sensor SPECIFICATION:

Measurement technology

Dual ultrasonic sensor

Measuring range

30 .. 4500 mm

Resolution & Accuracy

1.0mm, +/- 10mm

Sampling and transmission rates

Configurable from 30 seconds to 3600 seconds

Working temperature

-15 .. +60°C

Working humidity

0 .. 95% RH, non condensing

Sigfox SPECIFICATION:

Sigfox zones

select RC2-RC4 or RC1

Antenna

Internal Antenna 2dbi

Battery

02 x AA Type 1.5VDC, working time up to 10 years (depends on configuration)

RF Module complies to

CE, FCC, ARIB

Working temperature

-15°C..+60°C (with AA L91 Energizer)

Dimensions

H180xW50xD40

Net-weight

250 grams

Housing

Poly-carbonate, IP68

4. Dimensions

5. Scope of delivery

Sigfox ultrasonic level sensor

Magnet key

BTP1- PARTSKIT-ULA

6. Operation Principle

Upon power on, the Sigfox node has 60 seconds to wait for off-line configuration (via cable with ModbusRTU protocol).

After that, Sigfox node will send the first message to Base station.

Then during the operation, there are 03 cases of sending data to base station:

1. When the sensor sampling time interval is reached, the Sigfox node will read the data from Input or sensor and performing the calculation. After that it will check calculated value with alarm thresholds. If the calculated was out off the threshold values (Lo or Hi), called alarm, and the number of times of alarm did not pass the limit of number of alarms, then it will send data to Base station immediately;

NOTE: Once sending the data to base station by this alarm event, the timer of sending time interval will be reset;

2. When the sending time interval is reached, it will send data to Base station immediately, regardless of value;

3. By using the magnet key, the Sigfox node can be triggered to send data to base station immediately. There will be a beep sound from the buzzer meaning the data has been sent.

NOTE:Once sending the data to base station by the magnet key, the timer of sending time interval will be reset;The shortest time interval between the two manual triggers is 15s. if shorter than 15s, there will be no data sending and you will not hear the beep sound.

6.1 LED meaning

Whenever the data is sent to base station, the LED will lit with color codes as below:

RC1: RED colour

RC2: GREEN colour

RC4: BLUE colour

6.2 Magnet Key Function

the magnet key can only be used for the first 60 seconds after powering up.

6.2.1 Menu configuration

There are 3 configuration menus: tx_repeat, downlink_flag, radio configuration.

We use the magnet key to enter the menus as follows:

6.2.1.1 tx_repeat

Hold the magnet key 2s  ->  When the Red LED is on, it means entering the tx_repeat configuration menu. Then release to configure it.

Light touch to configure. After touching if the Red LED flashes once, tx_repeat = 0 (send 1 time). After touching if the Red LED blinks twice, it is tx_repeat = 1 (send 3 times).

6.2.1.1 downlink_flag

Hold the magnet key 5s  ->  When the Green LED is on, it means entering the downlink_flag configuration menu. Then release to configure it.

Light touch to configure. After touching if the Green LED flashes once, it is downlink_flag = 0 (downlink is not allowed). After touching if the Red LED blinks twice, it is downlink_flag = 1 (downlink is allowed).

6.2.1.1 radio configuration

Hold the magnet key 10s  ->  Blue LED is on, it means entering the Radio Configuration menu. Then release to configure it.

Light touch to configure. After touching if the Blue LED blinks once, it is Radio Configuration = 1. After touching if the Blue LED flashes twice, it is Radio Configuration = 2. After pressing if the Blue LED flashes 4 times, it is Radio Configuration = 4.

6.2.2 Exit the menu:

There are 3 ways to exit the menu:

Hold for 3s, the LED turns off to exit the menu;

Wait 30 seconds, then exit the menu;

Take out the battery, it all starts over (outside the menu)).

6.3 RC technical details

The RF transmit power will be automatically set as the max value as allowed by the Zone.

Sigfox Radio Configuration (RC) defines the radio parameters in which the device shall operate: Sigfox operating frequencies, output power, spectrum access mechanism, throughput, coexistence with other radio technologies, etc.

Each radio configuration includes 4 uplink classes: 0u, 1u, 2u, and 3u.

The Sigfox network globally works within the ranges from 862 to 928 MHz. But not all RCs require such a wide range of operation.

RC1

RC2

RC4

Uplink center frequency (MHz)

868.130

902.200

920.800

Downlink center frequency (MHz)

869.525

905.200

922.300

Uplink data rate (bit/s)

100

600

600

Downlink data rate (bit/s)

600

600

600

Sigfox recommended EIRP (dBm)

16

24

24

Specifics

Duty cycle 1% *

Frequency hopping **

Frequency hopping **

* Duty cycle is 1% of the time per hour (36 seconds). For an 8 to 12 bytes payload, this means 6 messages per hour, 140 per day.

** Frequency hopping: The device broadcasts each message 3 times on 3 different frequencies. Maximum On time 400 ms per channel. No new emission before 20 s.

*** Listen Before Talk: Devices must verify that the Sigfox-operated 200 kHz channel is free of any signal stronger than −80 dBm before transmitting.

Sigfox’s high limit EIRP recommendation is included in each column although regulations sometimes allow for more radiated power than the Sigfox recommendation.

Sigfox’s recommendation is set to comply with the Sigfox technological approach of:

Low current consumption

Balanced link budget between uplink and downlink communication

6.4 Add a device to the Backend Sigfox

Step 1: Log in to the sigfox backend website

Step 2: Click on Device

Step 3: Click New → Select a group

Step 4: Fill in the required information

Note: Some of our products may not have end product certification in time, to add the product to Backend Sigfox please follow the steps below.

Click on the text as shown below

Check the box as shown below to register as a prototype

6.5 The Effective Detection Range

6.6 Process of measurement

6.6.1 Measurement principle of Sigfox Sensor

When the sensor sampling time interval is reached, for example 2 minutes, the Sigfox node will wake up and switch ON the power supply to supply the energy to external sensor to start the measurement. Depends on the type and characteristic of external sensor, the sensor will take a certain time to finish the measurement.

Once reading the value, it can be scaled to any engineering value by the following formula:

Y = aX + b

Where:

X: the raw value from sensor

Y: the calculated value will be sent to Sigfox base station in the payload data.

a: constant (default value is 1)

b: constant (default value is 0)

So, if there is no user setting for a and b ==> Y = X

The Y value will be compared with Lo and Hi threshold. Please refer below the graph of alarm processing.

6.6.2 Calibration

Figure – Ultrasonic Level Transmitter Calibration

DB: Dead band 0..300 mm (This is a short range in front of the ultrasonic sensor can not measure distances)

H: Maximum measuring distance ( Span )

D: Distance

For example: Trash bin with maximum height to be measured 1200mm (H) and the maximum height to measure is 300mm (Recommended to install the lowest point that should be larger than the Deadband 300mm), then:

From here we can look up the trash level corresponding to the measured distance of the sensor by the formula: Y = aX + b.

Where: X is the measured distance (mm) and Y is the level (‰)

Distance (mm)

Level (‰)

300

1000

400

889

500

778

600

667

700

556

800

445

900

333

1000

222

1100

111

1200

0

Use the offline configuration tool to configure sigfox sensor. Write in the sensor the parameters a1 and b1.

Refer to Resigter table for more details.

6.7 Payload Data

The following is the format of payload data will be sent to Sigfox server. Length is 4 bytes.

Sensor type (1 byte)

Status (1 byte)

1 st - Parameter (2 bytes)

2nd - Parameter (2 bytes)

Meaning of Data in the Payload

Data

Size (byte)

Bit

Format

Meaning

Sensor type

1

all

Uint8

Sensor type = 0x0E means ULA sensor

Status: battery level

1

Bit 7 and 6

Uint8

Battery capacity in 04 levels

11: battery level 4 (99%)

10: battery level 3 (60%)

01: battery level 2 (30%)

00: battery level 1 (10%)

Status: error

Bit 5 and 4

Node status

01: error

00: no error

Status: alarm 1

Bit 3 and 2

Alarm status of 1st - Parameter (Y1 value)

11 : Hi alarm

01 : Lo alarm

00 : No alarm

Status: alarm 2

Bit 1 and 0

Alarm status of 2nd - Parameter (Y2 value)

11 : Hi alarm

01 : Lo alarm

00 : No alarm

1st - Parameter

2

all

Uint16

Y1 value: Level (x 0.1%)Y1 is calculated based on Y2 value by the formula:Y1 = Y2*a1+b1

2nd - parameter

2

all

Uint16

Y2 value: Distance(mm)

7. Offline configuration

Using the configuration cable to connect to the sensor as below picture.

Serial port configuration on computer: 9600 baud, None parity, 1 stop bit.Reading data by Function 3.Writing data by Function 16.

During connection with Modbus configuration tool, the Sigfox node will send all data in realtime: Battery, Battery level, Vref, Button status, reed switch status, PCB temperature, Measured value, alarm status.

Step to configure & check data:

NOTE: The Modbus configuration can be done in the first 60s after power up the Sigfox node. After 60s, if user can not finish the configuration, user need to reset the power of Sigfox node again, by removing battery in at least 15s.

Step 1: Install the Modbus Configurator Software in the link below

https://filerun.daviteq.com/wl/?id=qK0PGNbY1g1fuxTqbFW9SXtEvCw7bpc6

How to use the Modbus configuration software

Step 2: Plug the configuration cable to Computer via USB port;

Step 3: Open the housing with phillips screwdriver to unscrew M3 screws at the side of the housing

Step 4: Plug the connector to the configuration port;

Step 5:  Import the configuration file by importing the csv file: Go to MENU: FILE / Import New / => select the file with name CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-ULA.csv (in the link below). Then click Connect;

CONFIGURATION TEMPLATE FILE FOR SIGFOX WSSFC-ULA.csv

Here is the table of Data will be read by Modbus tool

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

# of Registers

Description

Range

Default

Format

Property

Comment

0

0

3

2

device info

string

Read

Product name

2

2

3

4

firmware version

1.0

string

Read

6

6

3

2

hardware version

1.0

string

Read

8

8

3

2

device ID

hex

Read

Product ID

10

A

3

4

device PAC

hex

Read

Product PAC

14

E

3

1

sen_type

1-255

uint16

Read

Sensor or Input Type

15

F

3

1

batt level

0-3

uint16

Read

Battery level

16

10

3

1

err_status

0-1

uint16

Read

Sensor error code

17

11

3

1

prm1 alm_status

0-2

uint16

Read

Alarm status of 1st parameter

18

12

3

1

prm2 alm_status

0-2

uint16

Read

Alarm status of 1st parameter

19

13

3

2

prm1 value

float

Read

1st calculated value

21

15

3

2

prm2 value

float

Read

2nd calculated value

23

17

3

1

batt %

10%, 30%, 60%, 99%

uint16

Read

Battery %

24

18

3

2

batt volt

0-3.67 vdc

float

Read

Battery Voltage

26

1A

3

2

temp

oC

float

Read

RF module temperature

28

1C

3

1

vref

0-3.67 vdc

uint16

Read

Vref of RF Module

29

1D

3

1

btn1 status

0-1

uint16

Read

Button status, 0: released, 1: pressed

30

1E

3

1

btn2 status

0-1

uint16

Read

Reedswitch status, 0: opened, 1: closed

Here is the table for Configuration:

Modbus Register (Decimal)

Modbus Register (Hex)

Function Code

(Read)

Function Code

(Write)

# of Registers

Description

Range

Default

Format

Property

Comment

256

100

3

16

1

modbus address

1-247

1

uint16

Read/

Write

Modbus address of device

270

10E

3

16

1

Radio Configuration

1-6

4

uint16

Read/

Write

RC zones selection 1, 2 ,4 is RCZ1, RCZ2, RCZ4

271

10F

3

16

1

tx_power

20

int16

Read/

Write

RF Tx power

272

110

3

16

1

tx_repeat

0-1

1

uint16

Read/

Write

Number of repeat, 0: 1 time, 1: 3 repeats

273

111

3

16

1

downlink_flag

0-1

1

uint16

Read/

Write

1: enable Downlink, 0: disable Downlink (Fw v1.0 hasn't got Downlink function)

274

112

3

16

2

cycle_send_data

3600

uint32

Read/

Write

Data sending cycle, in seconds

276

114

3

16

2

spare

Spare for future

278

116

3

16

1

alarm_limit

0

uint16

Read/

Write

Limit number of alarm sending in 24h

279

117

3

16

1

spare

Spare for future

280

118

3

16

2

sensor1: sampling_rate

120

uint32

Read/

Write

Sensor/Input 1 sampling rate, in seconds

282

11A

3

16

2

sensor1: calc_time

500

uint32

Read/

Write

Measurement time of sensor/input 1, in ms

288

120

3

16

2

prm1: a

1

float

Read/

Write

Constant a for scaling measured value 1

290

122

3

16

2

prm1: b

0

float

Read/

Write

Constant b for scaling measured value 1

294

126

3

16

2

prm1: High threshold

100000

float

Read/

Write

Hi Threshold for calculated value 1

296

128

3

16

2

prm1: High Hysteresis

10000

float

Read/

Write

Hysterisis for Hi for calculated value 1

298

12A

3

16

2

prm1: Low threshold

0

float

Read/

Write

Lo Threshold for calculated value 1

300

12C

3

16

2

prm1: Low Hysteresis

10000

float

Read/Write

Hysterisis for Lo for calculated value 1

302

12E

3

16

2

prm1: High cut

100000

float

Read/

Write

High cut value for calculated value 1

304

130

3

16

2

prm1: Low cut

0

float

Read/

Write

Low cut value for calculated value 1

306

132

3

16

2

prm2: a

1

float

Read/

Write

Constant a for scaling measured value 2

308

134

3

16

2

prm2: b

0

float

Read/

Write

Constant b for scaling measured value 2

312

138

3

16

2

prm2: High threshold

100000

float

Read/

Write

Hi Threshold for calculated value 2

314

13A

3

16

2

prm2: High Hysteresis

10000

float

Read/

Write

Hysterisis for Hi for calculated value 2

316

13C

3

16

2

prm2: Low threshold

0

float

Read/

Write

Lo Threshold for calculated value 2

318

13E

3

16

2

prm2: Low Hysteresis

10000

float

Read/

Write

Hysterisis for Lo for calculated value 2

320

140

3

16

2

prm2: High cut

100000

float

Read/

Write

High cut value for calculated value 2

322

142

3

16

2

prm2: Low cut

0

float

Read/

Write

Low cut value for calculated value 2

8. Installation

8.1 Locate the good place for Radio signal

To maximize the distance of transmission, the ideal condition is Line-of-sight (LOS) between the Sigfox sensor and Base station. In real life, there may be no LOS condition. However, the Sigfox sensor still communicate with Base station, but the distance will be reduced significantly.

ATTENTION:DO NOT install the Sigfox sensor or its antenna inside a completed metallic box or housing, because RF signal can not pass through metallic wall. The housing is made from Non-metallic materials like plastic, glass, wood, leather, concrete, cement…is acceptable.

8.2 Mounting

8.2.1 Installation method

Mounting the sensor under the bottom and at the center of the trash bin lid

WARNING:Avoid causing strong impact on the 2 probes on the sensor;DO NOT install the sensor in complete metal trash bin because the signal can't transmit to the Gateway

Step 1: Determine the center of the trash bin

Step 2: Mounting the sensor under the trash bin lid by fasten the 4 screws that are included

8.2.2 Installation conditions

Align the sensor so that it is vertical to the solid surface (1)

When installing, do not let the plastic bag inflate too much to block the path of the sensor. (2)

8.3 Battery installation

ENERGIZER L91 (recommended battery)

Steps for battery installation:

Step 1: Using Philips screw driver to unscrew 4 screws under the housing.

Step 2: Pull out the cover then insert 02 x AA 1.5VDC battery, please take note the poles of the battery.

ATTENTION: REVERSED POLARITY OF BATTERIES IN 10 SECONDS CAN DAMAGE THE SENSOR CIRCUIT !

Step 3: Insert the top plastic housing and locking the cover

9. Troubleshooting

No.

Phenomena

Reason

Solutions

1

Node does not send RF to base station periodically, LED does not blink

No power supply

Configuration sending cycle is incorrect

Check that the battery is empty or not installed correctly

Check the power supply

Check the send cycle configuration

2

Node does not send RF to base station according to the alarm, LED does not blink

The alarm configuration is incorrect

Running out of the number of alarms set for the day

Check alarm configuration

Check the configuration for the maximum number of alarms per day

3

Node does not send RF to base station when activated by the magnetic switch, LED does not blink

Magnetic switch has malfunctioned

Read the status of the magnetic switch via modbus (when powering or attaching the battery) to see if the magnetic switch is working.

4

Node has blinked LED when sending RF but the base station cannot received

Out of the number of RF packages per day (140 packages / day)

Check on the base station whether the event message exceeds the number of RF packets

5

Node has sent RF but the LED does not blink

LED malfunction

LED welding is not good

Check LED condition and LED weld

6

The value of the sensor is 0

No pressure

Lost connection with the sensor

Check pipe pressure

Check sensor connection

7

The node does not send RF and the RF module is hot

Insert the battery in the opposite direction

Short circuit

Warranty or replacement

8

RSSI is weak and often loses data

Distance between Node and Gateway is far or there are many obstructions

Connection to Antenna problem

Check Antenna position

Install Node in a well ventilated location

10. Support contacts

Manufacturer

Daviteq Technologies IncNo.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

Daviteq Sigfox Sensor on SDR Dongle Gateway

1. Download the Sigfox Network Emulator.

You can download SNE for the software and drivers from the link: https://support.sigfox.com/products#sdr

2. Register the device on the Sigfox Network Emulator of your local webpage.

Click CONFIGURATION > RADIO. 

From the left side of the local web page, select RADIO for your Radio Configuration.

For example, choose RC4 from the Radio Configuration's dropdown menu if you want to connect to the device in RC4. 

After completing your registration page, please click SAVE.

Next, click DEVICES.

Note: You can find the value for Identifier (hex!) which is the ID located on the label of the sensor.

For example, Device 1 has the digits of ID as 02A30DAD.

After completing your registration page, please click SAVE.

3. Manage your view for the payload of the device.

Click MESSAGES.

- The device has 2 modes of operation which are Configuration mode and Power mode. In order to be able to send data during the power supply provided, the power source should last after 60 seconds to enter the power mode.

Configuration mode allows you to read or write the parameter's value which is the property of R/W of your device such as CURRENT_CONFIGURATION, RADIO_CONFIG, SERVER_CONFIG, etc.

Power mode allows your device to transmit uplink or receive downlink data. This is when the sensor is ready to communicate with the Sigfox network.

If your device operates with a period of time to send data, the device will send uplink data in every cycle.

If your device sends the uplink data intentionally, you can draw the Magnet key to the Contact point as below.

The device provides means to force an uplink transmission in one time.

In both cases, the data packet will be sent to your SDR Dongle gateway. Measuring data is formed in several specific payloads.

For the meaning of every uplink message or downlink data, please refer to the next section in the hint below:

Use of the Daviteq SigfoxFrame software

4. Send Downlink to the device

As your device communicates with the SDR Dongle, you can prepare downlink data in advance to meet the schedule right after one of the uplink frame transmissions from the device on the Sigfox network.

The downlink data is added to the device downlink queue, downlinks may be sent only after an uplink from the device.

1. Click CONFIGURATION > CALLBACKS, select DIRECT in Downlink mode field

If you plan to create the downlink data for your device, please follow the instruction below.

Parameter

PRM_ADDRESS

PRM_LENGTH

PRM_FORMAT

PRM_VALUE

DOWNLINK_TYPE

Full Downlink

(bytes)

1

1

4

2

8

DISTANCE_THRESHOLD

0x32

0x02

unit16

Example:

10 ==> 0x000A0000

0x0005

For the Sigfox People Counter sensor, a parameter "DISTANCE_THRESHOLD" that supports the downlink property should only calculate the value according to that PRM_VALUE format. The Example of a Decimal number "10" and a Hex number "000A0000" are shown, Full Downlink = 3202000A00000005. This indicates the value of the DISTANCE_THRESHOLD parameter is set to 10 if you write this downlink data into the device.

For example, your newly-calculated DISTANCE_THRESHOLD's value is 1600, Full Downlink = 3202064000000005.

For ease of calculation, you should identify a Decimal number, then convert it to a Hex number.

2. Enter your desired downlink data, 3202064000000005.

After completing your setting, please click SAVE.

3. Enable your SET OF CALLBACKS.

5. Configure Callbacks to forward payloads to Microsoft Teams

1. Click CONFIGURATION > CALLBACKS > New.

2. Navigate to the dashboard of Callbacks - DATA.

3. Select Type > UPLINK.

4. Select Channel > URL.

5. Select Use HTTP Method > POST.

6. Fill out the form according to the following table:

Field

Input field

URL pattern

http://192.168.10.177:1880/sigfox/uplink-message

Header

Authorization

value

BasicYXBwLWtleS05MWE2Y2FjMi03YzFhLTQ2Y2UtYWJhNS1jNWJjNmU2N2UwMmI6c2VjcmV0LWtleS1iZGIwNGYyOC1hYjcxLTQ1MDktOTE4Yi05NmJkMTMzZGMxNDA=

Content type

application/json

Body

{"device": "{device}","time": "{time}","seqNumber": "{seqNumber}","device": "{device}","station": "{station}", "rssi": "{rssi}", "snr": "{snr}", "data": "{data}"}

6. Configure Callbacks to forward payload to Daviteq Globiots platform

1. Click CONFIGURATION > CALLBACKS > New.

2. At the section Downlink data, select CALLBACK at Downlink mode field

3. Navigate to the dashboard of Callbacks - DATA.

4. Select Type > BIDIR

4. Select Channel > URL.

5. Select Use HTTP Method > POST.

6. Fill out the form according to the following table:

Field

Input field

URL pattern

https://resources.globiots.com/rest/api/v1/sigfox-service/process-messages

Header

Authorization

value

Copy this value from Globiots: Login Globiots, click the Sigfox sensor name, click tab Sigfox Network Server Config, copy Header value and paste to value field on Callbacks-DATA section

Content type

application/json

Body

{"device": "{device}","time": "{time}","seqNumber": "{seqNumber}","device": "{device}","station": "{station}", "rssi": "{rssi}", "snr": "{snr}", "data": "{data}"}

Vizuo Application for Sigfox Sensors

Manual For Sigfox Sensor as the following link: https://daviteq.com/en/manuals/books/manual-for-sigfox-sensors

1. Introduction

Vizuo is a web-based software application to remotely configure device, parameter, alarm and event. In addition, Vizuo displays current values, historical values of parameters as well as events, alarms. Values of parameter are stored on database of GLOBIOTS server. Below figure describes the system which uses Vizuo application software:

2. User Information and Actions

2.1 Sign in

- Open a web browser (Google Chrome/Firefox/Internet Explorer…).- Enter address in URL: http://vizuo.globiots.com/- Sign-in page displays as follow:  • Enter username and password  • Click “Sign in” button.

- For user first time sign-in or reset password, user’s password must be changed after successful sign-in- Screen of change password:

2.2 Configure Node

2.2.1 Node Definition

In Organization Chart Panel, Node is used to create Organization Chart. Node name should be geographical area, type of energy or responsible person. A Node includes one or more sub-Node and Device

2.2.2 Organization Chart

To close or open “Organization Chart” panel, you can click

on left corner of screen Organization Chart page includes all Node and Device in system:  • Node name  • Number using device of account/Max number device of accountRight click on Node name, menu of Node displays:  • New: Create new Node, Device  • Delete: Delete Node  • Assign to account: Assign Node and sub-Node to account  • Rename: Change name of Node

2.2.3 Create a Node

To Create a sub-Node:  (1) Select Node  (2) Right click and select “New”  (3) Click “Node” to create new Node  (4) Enter sub-Node name and click button Save, then click button OK to confirm

2.2.4 Rename Node

To change name of Node, right click on Node name → select Rename Or double click on Node. Enter new name and click button “Save Changes” to complete

2.2.5 Delete node

In Organization Chart, select Node that you want to delete, right click Node name → select “Delete”, click button OK. Enter Username and Password of Account to confirm- Do not delete a Node that is assigned to account- Do not delete a Node that includes sub-node

3. Adding the Daviteq Sigfox Sensors to Vizuo Globiots

3.1 Create a new Daviteq Sigfox Sensor

To create a new Daviteq Sigfox Sensors:  (1) Select Node  (2) Right click and select “New”  (3) Click “Sigfox” to create a new Device  (4) A box appears:

At Basic information tab,  Enter parameters of Device:- Name: Name of Device (require 12 characters)- Sigfox Device ID: provided by manufacturer. Note: Do not enter the first character of Device ID string (0). - Click “Generate” button to create Device ID or enter ID directly.- Radio Configuration: Choose the right RC as Sigfox Backend/SDR Dongle.

At Sigfox Network Server Config tab:- Device Category: Choose the right Sigfox sensor category. Default category is Daviteq Raw Payload Sensor.- Uplink Message: The information in this section is auto-generated to configure the Callbacks on Sigfox Backend/Dongle

Click “Save” to continue, click button OK to confirm, and enter admin user and password to complete.Note: After creating a Daviteq Sigfox sensor on Vizuo application, the connection between the Network Server and Vizuo to forwarding sensor data must be configured. Refer to the instructions in relevant Network Server document for this configuration.

3.2 Configure Parameter

Note: After receiving first uplink message, the default parameters are automatically created.

Click on Device, right-click, select ParameterIn List Parameters Page  • “Import Parameter”: click to Import Parameters from excel file. Excel file must have default structure.  • “Export Parameter”: click to export parameter to excel file.  • “Add parameter”: click to add a new parameter.    o Name: Parameter name    o Type: Real Parameter or Virtual parameter       Real Parameter: Parameter from Sigfox sensors       Virtual Parameter: Parameter only in Server. Virtual parameter is create from formula of one or multi real parameter       If type is Virtual parameter, formula in Expression should be added

        Mathematical Operators

Operator

Description

+

Additive operator / Unary plus

-

Subtraction operator / Unary minus

*

Multiplication operator, can be omitted in front of an open bracket

/

Division operator

%

Remainder operator (Modulo)

^

Power operator

        Boolean Operators

Operator

Description

=

Equals

==

Equals

!=

Not equals

<>

Not equals

<

Less than

<=

Less than or equal to

>

Greater than

>=

Greater than or equal to

&&

Boolean and

||

Boolean or

        Bit Operators

<<

Left-shift bit operator in byte

>>

Right-shift bit operator in byte

&

AND bit operator in byte

|

OR bit operator in byte

       

 Mathematical Functions

Function*

Description

RANDOM()

Produces a random number between 0 and 1

MIN(e1,e2, ...)

Returns the smallest of the given expressions

MAX(e1,e2, ...)

Returns the biggest of the given expressions

ABS(expression)

Returns the absolute (non-negative) value of the expression

ROUND(expression,precision)

Rounds a value to a certain number of digits, uses the current rounding mode

FLOOR(expression)

Rounds the value down to the nearest integer

CEILING(expression)

Rounds the value up to the nearest integer

LOG(expression)

Returns the natural logarithm (base e) of an expression

LOG10(expression)

Returns the common logarithm (base 10) of an expression

SQRT(expression)

Returns the square root of an expression

SIN(expression)

Returns the trigonometric sine of an angle (in degrees)

COS(expression)

Returns the trigonometric cosine of an angle (in degrees)

TAN(expression)

Returns the trigonometric tangens of an angle (in degrees)

COT(expression)

Returns the trigonometric cotangens of an angle (in degrees)

ASIN(expression)

Returns the angle of asin (in degrees)

ACOS(expression)

Returns the angle of acos (in degrees)

ATAN(expression)

Returns the angle of atan (in degrees)

ACOT(expression)

Returns the angle of acot (in degrees)

ATAN2(y,x)

Returns the angle of atan2 (in degrees)

SINH(expression)

Returns the hyperbolic sine of a value

COSH(expression)

Returns the hyperbolic cosine of a value

TANH(expression)

Returns the hyperbolic tangens of a value

COTH(expression)

Returns the hyperbolic cotangens of a value

SEC(expression)

Returns the secant (in degrees)

CSC(expression)

Returns the cosecant (in degrees)

SECH(expression)

Returns the hyperbolic secant (in degrees)

CSCH(expression)

Returns the hyperbolic cosecant (in degrees)

ASINH(expression)

Returns the angle of hyperbolic sine (in degrees)

ACOSH(expression)

Returns the angle of hyperbolic cosine (in degrees)

ATANH(expression)

Returns the angle of hyperbolic tangens of a value

RAD(expression)

Converts an angle measured in degrees to an approximately equivalent angle measured in radians

DEG(expression)

Converts an angle measured in radians to an approximately equivalent angle measured in degrees

         Data Type Conversion Functions

Function

Description

FLOAT

Converts values into 32-bit floating point numberFLOAT(0x02, 0x02, 0x02, 0x02)

FLOAT([2000], [2001], [2002], [2003])

UINT8

Converts values into 8-bit unsigned integer number

UINT8(22)

UINT8([2000])

INT8

Converts values into 8-bit signed 2's complement numberINT8(22)

INT8([2000])

UINT16

Converts values into 16-bit unsigned integer number

UINT16(22, 23)

UINT16([2000], [2001])

INT16

Converts values into 16-bit signed 2's complement number

INT16(22, 23)

INT16([2000], [2001])

UINT32

Converts values into 32-bit unsigned integer number

UINT32(0x02, 0x02, 0x02, 0x02)

UINT32([2000], [2001], [2002], [2003])

INT32

Converts values into 32-bit signed 2's complement number

INT32(0x02, 0x02, 0x02, 0x02)

INT32([2000], [2001], [2002], [2003])

GETBYTES

Get bytes from hexadecimal stringGETBYTES([Address], position, length)POSITION là thứ tự byte, start là 0, index từ trái sang phải, length số byte cần lấyExample:Hexadecimal parameter with start address of [6100] and hexadecimal value of 0001020304 (00 01 02 03 04):byte 0: 00byte 1: 01byte 2: 02byte 3: 03byte 4: 04GETBYTES([6100], 3, 1) => result: 03GETBYTES([6100], 1, 3) => result: 010203

          Logical Functions

Function*

Description

NOT(expression)

Boolean negation, 1 (means true) if the expression is not zero

IF(condition,value_if_true,value_if_false)

Returns one value if the condition evaluates to true or the other if it evaluates to false. The IF could be in another IF function

AND(expression 1, expression 2, expression 3, …)

Returns 1 (means true) if all true expressions, return 0 (mean false) if at least one false expression.

OR(expression 1, expression 2, expression 3, …)

Returns 1 (means true) if at least one true expression, return 0 (mean false) if all false expressions.

   

Supported Constants

Constant

Description

e

The value of e, exact to 70 digits

PI

The value of PI, exact to 100 digits

TRUE

The value one

FALSE

The value zero

NULL

The null value

         Example 1:           Value of Virtual Parameter have address at 2012 is calculated as follow [2012] = [2000] + [2002. ]In which address 2000 and 2002 are two real parameters          Example 2:

           IF [2000]>10 then [2005]=1            IF [2000]<=10 then [2005]=2

         Example 3:

           IF [2000]=1 And [2005]=2 then [2010]=5            IF [2000]=!1 And [2005]=!2 then [2010]=[2007]+10

        Example 4:

           IF [2000]>10  then [200A]=1            IF [2000]<10 And [2010]=1 then [200A]=5            IF [2000]<10 And [2010]=!1 then [200A]=10

Example 5:

If value from [2000] is 0x40, [2001] is 0xb0, [2002] is 0x00 and [2003] is 0x00. Then result form expression FLOAT([2000], [2001], [2002], [2003]) is 5.5

   o Unit: Unit of parameter    o Logged: Tick to permit saving value of parameter into database    o Logging Priority: enter any value    o Time to live: select how long data will be stored in database    o Data Type: Type of parameter    o Data Length: Length of data type, byte unit, display automatically with data type. If data type is String, data length should be input    o Address: Address on the server/cloud to store value of parameter    o Decimal Places: number of decimal after the comma.  • Save: click to finish  • “Delete All”: click to delete selected parameters  • Edit: click to edit this parameter  • Delete: delete parameter

3.3 Delete Daviteq Sigfox Sensors

To delete a Device: Right click Device name and select Delete and click OK to confirm

3.4 Clone Daviteq Sigfox Sensors

To create a new Device have same Parameters, Alarm Config, Modbus Command, Menmap, Event Configure …, select original Device, right-click, select “clone”. Below page appears

Refer to 3.1 “Create a new Device” for more details.

3.5 Replace Daviteq Sigfox Sensors

To replace Device:  • Right click Device name and select Replace  • A box displays:    o Enter the Sigfox Device ID of new device    o Click “OK” to continue  • A box appearsInput admin username and password, then click “Yes” to complete device replacement.

3.6 Rename Daviteq Sigfox Sensors

To change name of Device: Right click Device name, select Rename, and enter new name.

3.7 Downlink type 0 and downlink type 5 for Sigfox Sensors

3.7.1 Get information of connection between Sigfox Backend and Globiots

From Vizuo main screen, click on the Sigfox device name, click tab Sigfox Network Server Configuration, save information of THE URL OF THE END POINT and information of HEADER VALUE for later configuration

3.7.2 CALL BACK configuration on Sigfox backend

3.7.2.1. Enable Downlink Mode

Login Sigfox backend, click Device Type menu, click relevant Device Type of the sensor, at INFORMATION menu, click EDIT button, the below screen will be shown.

Select CALLBACK from drop list of Downlink mode in the DOWNLINK DATA section.

3.7.2.2 Create a CALLBACK

Click CALLBACKS menu on the right, the below screen will shown.

Click NEW button on the top right, select Custom callback from popup menu

After clicking CUSTOM CALLBACK section, the CALLBACK configuration screen will be shown

Fill out the form according to information in the following table, then click on Ok to save

Field name

Input value

Select Type

DATA – BIDIR

Select Channel

URL

URL pattern

https://resources.globiots.com/rest/api/v1/sigfox-service/process-messages

Select Use HTTP Method

POST

Send SNR

✓

Header name

Authorization

value

As information of HEADER VALUE in section 3.7.1

Content type

application/json

Body

{  "device": "{device}",  "time": "{time}",  "seqNumber": "{seqNumber}",  "deviceTypeId": "{deviceTypeId}",  "data": "{data}"}

After completing the CALL BACK configuration, click on round icon right below text DOWNLINK (as below figure), then click OK to activate the downlink function in the CALL BACK.

3.7.3 Create and send downlink type 0

At the organizational chart, right click on the Sigfox Sensor then select Downlink

In Downlink configuration page, click tab “Type 00”

Input the downlink 0 payload (16 hexa) for the sensor, then click synchronize Type 00, then select OK to complete inputting the downlink 0 configuration.

Note:

User could click Copy Latest Configuration button to copy latest configuration and edit this configuration to create new configuration.

The below screen will be showed after clicking OK button

After that, the downlink type 0 will be sent to Sigfox Backend when there is PARAMETER_UPDATE or HEART_BEAT uplink message from the Sigfox Backend to Globiots.

The result of downlink process could be checked after the second PARAMETER_UPDATE or HEART_BEAT uplink. The downlink value in the device memory will be shown on section VALUE ON MEMMAP

3.7.4 Create and send Downlink type 5

At the organizational chart, right click on Sigfox Sensor then select Downlink.

In Downlink configuration page, select tab “Type 05”

Input parameter address (following the memory map of sensor) in Address (hex)

Fill parameter name in Parameter Name

Select data type of the parameter in the drop list at Data Type field.

Input value of parameter in Value field.

Click Add button to add input data.

Click on Synchronize Type 05 button and click OK button confirm the input of downlink type 5.

After that, the downlink type 5 will be sent to Sigfox Backend when there is PARAMETER_UPDATE or HEART_BEAT uplink message from the Sigfox Backend  to Globiots.

4. Report

4.1 Create a new report

- To create a new report:  • In menu Management, select Report  • In Report page select “+ ” to create a new tab  • Report Page will display as follow:Enter full information:    o Name: Name of Report tab    o Report Type: Historical Trending (for parameter trend)    o Parameter Configuration:       Name: Name of parameter which display in report. Name might input text or name of parameter.       Device: select Device       Parameter: select parameter of device which you want show       Click “Add” to add parameter. A report might have some parameters.    o After completing adding parameter, click “save” to finish

4.2 Configure Report

- In Report page, select Report name which you want configure  • Click “Delete” to delete report  • Click “Edit” to edit report       To edit available parameter, click in Action column, edit parameter, click Update       To delete parameter, click in Action       To Add new parameter: enter full information and click “Add”

4.3 View report

Select Time in “From … To …” and click “Show” to view data of parameters on report tab

Click on name of parameter (at the bottom of the report) to temporarily Show/Hide parameter on the report.

4.4 Export report

After click button Show to view report, click on top right corner of screen, select Export to Excel or Export to pdf or Export to csv

      Click Export to Excel, select version of Excel (2003 or 2007), click Export. The exported file will be store on your PC       Click Export to csv, select version Date Format in csv file, click OK. The exported file will be store on your PC       Click Export to pdf, the exported file will be store on your PC

5. Dashboard

5.1 Dashboard Description

Dashboard views input text, last value and value from database. Each Dashboard is organized in one tab. When value is from database, dashboard will update the value after specific time. Dashboard consists of containers which contain widgets inside.

5.2 View Dashboard

- In Home screen, select menu Management → select sub-menu Dashboard to display current value of parameters.- Screen of status “Dashboard”:

- Screen of status “Stop” of Dashboard:

 • (1): Display list of Dashboard tabs which user are assigned to view  • Button “Run”: click to run Dashboard.  • Button “Stop”: click to stop selected Dashboard.  • Button “Delete”: click to delete Dashboard  • Button “Edit”: click to edit Dashboard  • Button “Add Container”: click to add new Container in Dashboard  • Button   : click to full screen  • Button “Export”: click to export Dashboard to Excel File  • Button “Import”: Click to import Dashboard to Excel File

5.3 Create new Dashboard

- In Dashboard screen, click symbol “+” to create new tab

- New window display

 • Name: Name of new Dashboard tab  • Stop real time after: Running time of Dashboard to get real time data from iConnector. After this period of time, Dashboard will stop to get real time data from iConnector.Click button “Run” on top right corner to continue to get real time data  • Push Interval: Frequency to get real time data from iConnector    Click Save to complete creating new Dashboard

5.4 Create New Container

- In Dashboard tab, click Add Container to add new Container

 • Title: Name of container  • Format: Font size, Style, Text color, Text align, Background.  • Poll Interval: Frequency to get logged data from database to view on Dashboard  • Layout: Select layout of container. There are 07 layouts select    Click Save to complete creating Container

5.5 Configure a Container

(1): Edit Container(2): Delete container.Click   to Edit Container. Following screen will appear

- Click Add Widget to add new widget

Note: Stop Dashboard before configure Container/Widget

5.6 Widget

5.6.1 Widget Description

Widget is a basic element of Dashboard to view constant, value of parameter. Currently, Vizuo has below widgets

After select widget click Add to add new widget to Container

5.6.2 Widget Table

- Paging: Tick to view table more than one page- Border: Select type of border: None, Border and Inside- New Column: Click to add new column- New Row: Click to add new row     : Move column    : Configure cell

    : Close/Delete column or row

 

: Copy new row      : Click to select type of border for cell- Configure Row- After clicking , configuration screen for new row will appear

   (1): Format    (2): ConfigureChoose Data type: Constant (input text), Data from Database (Device Name, Parameter Name, Unit of Parameter, Last value of parameter in Database, time stamp of last value)

5.6.3 Widget Line Chart

Click to configure widget Line Chart, the following screen will appear

 • Title: Line Chart name  • Style: Format of Title  • YAxis: Fixed or Auto. If choose Fixed, enter min & max value. If select Auto, software will specify Max of Y axis based on value of displayed parameter.  • Type: Data type of parameter to view (Data from device or from database)Type Database: Logged data from database, time period include: Today, Yesterday, Last 3 days or Custom (From…To)  • Line configuration: Select displayed parameter and displayed label (input text, parameter name or device name)Click Add button to add parameter to line chart. A line chart could view some parameters

5.6.4 Linear Gauge

Click to configure widget Line Gauge, the following screen appear

 • Title: Name  • Style: Format of title  • Direction: Vertical or Horizontal Linear Gauge  • Min, Max: Range of Gauge  • Range Color: Auto or CustomAuto: Color of Gauge changes according to value of parameterCustom: Configure specific color to specific range of value of parameter  • Data: Select type of display parameter (last logged data from Database)  • Device/Parameter: Select displayed parameter  • Write: Tick to enable to write value to parameter. Writing value to parameter by holding and drag on body of Linear GaugeClick Save Changes to complete configuration

5.6.5 Solid Gauge

Click to configure widget Solid Gauge, the following screen appear

 • Title: Name  • Style: Format of title  • Min, Max: Range of Gauge  • Range Color: Auto or CustomAuto: Color of Gauge changes according to value of parameterCustom: Configure specific color to specific range of value of parameter  • Data: Select type of display parameter (last logged data from Database)  • Device/Parameter: Select displayed parameterClick Save Changes to complete configuration

5.6.6 Circular Chart

Click to configure widget Solid Gauge, the following screen appear

 • Title: Name  • Style: Format of title  • Min, Max: Range of Chart  • Range Color: Auto or Custom  • Auto: Color of Chart changes according to value of parameter  • Custom: Configure specific color to specific range of value of parameter  • Data: Select type of display parameter (last logged data from Database)  • Device/Parameter: Select displayed parameter  • Write: Tick to enable to write value to parameter. Writing value to parameter by holding and drag on body of Circular ChartClick Save Changes to complete configuration

5.6.7 Column Chart

Click  to configure widget Solid Gauge, the following screen appears

• Title: Column Chart name  • Style: Format of Title  • Type: Data type of parameter to view (Data from database)  • Type Database: Logged data from database, last value or value series in time period include: Today, Yesterday, Last 3 days or Custom (From…To)  • Column configuration: Select displayed parameter and displayed label (input text, parameter name or device name)Click Add button to add parameter to column chart. A column chart could view some parameters

5.6.8 EMS Report

EMS Report views report for accumulative parameter such as running hour, kWH during period of timeClick  to configure widget EMS report, the following screen appears:

 • Tittle: Report title  • Style: Format of tittle  • Report type: Daily, Weekly, Monthly  • Data range: Today, yesterday, last month, this month, last week, this week  • Column Configuration: Configure displayed value of parameter and displayed name of parameterClick Add to add parameter for report

5.6.9 Pie Chart

Pie Chart compares values between some parameters. Click to configure widget EMS report, the following screen appears:

 • Tittle: Tittle of pie chart  • Style: Format of tittle  • Type: Data type, last value in database  • Configuration: Configure displayed value and displayed name of parameter

5.6.10 HTML Canvas

How does the HTML Canvas widget work?

When you select the widget, you will find a code editor as depicted in the image below. The widget works with the same HTML/CSS/JS you would code when creating a simple website. There's no need to learn a special API.

It also considers the case when you may need to use a 3rd library (e.g. jQuery), so you can add these by inserting an URL containing the library.

IMPORTANT NOTE:

You should consider when writing code in this widget that all the execution will be made by your browser, we do not do any kind of poly-filling here, so it's up to your browser to support all the features that you make use of.

The HTML code will be:

The CSS code will be:

The Java Script code will be:

Full screen editor code.

Get embed link: Public link, private link.

Preview layout with current code before to save change.

HTML Canvas Example

Show Last Value

Link

Show Historical Trending Data Log

Link

Get Data From API

Link

6. Export Raw Data

- In menu Management, select Import/Export Raw Data- Select Export tab

 • Parameter: select Device and Parameter  • Time Zone: select time zone  • Data format: select Data format for export time  • From …To: Duration of time to exportClick “Export” to export value of parameter to csv file

7. Package Configuration

In menu Configuration, select package configuration. The List of Packages displays as follow:

- Click “Add package” to add new Package

 • Step 1: Enter basic information and click continue to next step  • Step 2: Select functions for package

In Permission, select appropriate authorities and click continue to next step  • Step 3: View information of configuration and click “save changes” to finish- Click “Edit” to Edit available Package- Click “Delete” to Delete Package

8. Administrators

8.1 Account Management

- Account might have sub-account to manage and assign authorities.- In Home screen, select menu Administrators → select sub-menu Account Management- In screen of account list, click button “Add account” to create new account.

Enter information account into panel (1).Email: enter email address. Email is unique.Click button “Continue” to go to step 2.- Field with mark * must be filled- In email address, uppercase and lowercase are the same.- Select right Time Zone for user.- After click button “Continue”, screen of step 2 should appear:

Enter information of admin user into panel (1):  • Username: Enter username. Username is unique.  • Email: Enter email address. Email is unique.  • Contact Number: Enter phone number. Phone number is unique.  • Click button “Continue” to go to step 3.- Screen of step 3 should appear:

(1) Select package for account.Click button “Continue” to go to step 4.- Screen of step 4 should appear:

 (1) Display basic information of account in step 1.  (2) Display information of admin user in step 2.  (3) Display assigned package information in step 3.Click button “Save” to save configuration.After click button “Save”, confirmation screen should appear and click “OK” to finish.- After successfully create new account, an admin user of account is also created.- Number of used user of account increases by one for admin user.- Information of admin user should be in user list.

8.2 User Management

User is created by following steps:- In Home screen, click menu Administrators → select sub-menu User Management- In screen of user list, click button “Add user” to add new user.

Enter basic information into panel (1).  • Contact Number: Enter contact number. The number is unique.  • Click button “Continue” to go to step 2.- After click button “Continue”, screen of step 2 should appear:Enter information for user to sign-in into panel (1):  • Email: enter email address. Email is unique.  • Username: enter username for sign in. Username is unique. Username has at least 6 characters.  • Password: default password is “abc@123”. User must change password when user sign in in the first time.  • Click button “Continue” to go to step 3.- Enter full information for user.- Uppercase and lowercase of email and username are the same.Example: username “USERNAME1” is the same as username “username1”.- Screen of step 3 should appear:

 (1) Display basic information of user in step 1.  (2) Display information for sign in in step 2.Click button “Save” to save information.After click button “Save”, confirmation screen should appear and click button “OK” to finish.- If number of unused user of account > 0, user will be created successfully. Number of used user should increase by 1.- If number of unused user of account is equal to 0, user will not be created successfully.Screen of notification should appear when number of unused user of account is equal to 0:

8.3 Group Management

- Group is used to assign authorities to users.- In Home screen, select menu Administrators → select sub-menu Group Management- In screen of group list, click button “Add Group” to create new group of account.

Enter basic information of group into panel (1).  • Group Name: Enter group name. Group name is unique.  • Click button “Continue” to go to step 2.- After click button “Continue”, screen of step 2 should appear:

 • Select assigned functions for group in area  • Only display assigned functions of account.  • Select one function to assign, then click into area (1) to display authorities of selected function. Click authority to add into group.  • Click mark “x” (2) to remove authority.  • Click button “Continue” to go to step 3.- Screen of step 3 should appear:

 • (1) Display available nodes of account. Tick nodes to assign to group.  • Click button “Continue” to go to step 4.- Screen of step 4 should appear:

 • (1) Display list of users. The users have not been assigned to the group.  • (2) Display list of users which has already been assigned to the group.  • Button “Assign”: click to assign selected user to group. After click “Assign” button, selected user should be in the list in panel (2).  • Button “Remove”: remove user from group. After click button “Remove”, selected user should be in the list in panel (1).  • Click button “Continue” to go to step 5.- Screen of step 5 should appear:

 • (1) Display list of Dashboard of signing in group. The Dashboard has not been assigned to group.  • (2) Display list of Dashboard of signing in group. The Dashboard has already been assigned to group.  • Button “Assign”: click to assign dashboard to group. Assigned dashboard should be in panel (2).  • Button “Remove”: remove dashboard out of group. Removed dashboard should appear in panel (1).  • Click button “Continue” to go to step 6.- Screen of step 6 should appear to view Summary information of group from step 1 to step 8.  • Click button “Save” to save information.  • After click button “Save”, confirmation screen should appear and click button “OK” to finish.

9. Support contacts

Distributor in Malaysia

AVO Technology Sdn. Bhd.

Official Website: www.avo.com.my

No. 17, Jalan 3/23A, Taman Danau Kota, 53300 Kuala Lumpur, Wilayah Persekutuan Kuala Lumpur, Malaysia

General : +603-4143 2288

Mobile : +012-376 7181Fax : +603-4143 3388

Distributor in Australia and New Zealand

Templogger Pty Ltd

Tel: 1800 LOGGER

Email: contact@templogger.net

Manufacturer

Daviteq Technology Company Ltd.No.11 Street 2G, Nam Hung Vuong Res., An Lac Ward, Binh Tan Dist., Ho Chi Minh City, Vietnam.Tel: +84-28-6268.2523/4 (ext.122)

Email: info@daviteq.com | www.daviteq.com