daviteq WSSFCB-NH3 User Manual

For sigfox-ready ammonia gas sensor with ble

Advertisement

Quick Links

USER GUIDE FOR SIGFOX-READY
AMMONIA GAS SENSOR WITH BLE
WSSFCB-NH3
WSSFC- NH3-MN-EN-01
This document is applied for the following products
SKU
WSSFCB-NH3
WSSFCB-NH3-8-01
Item Code
WSSFCB-NH3-9-01
0. Configuration Check List
STEP 1: Select RC
1. Select RC zone
STEP 2: Check ID and PAC
Use Modbus Configuration Cable to read the ID and PAC values
HW Ver.
1.1
Wireless Sigfox Ammonia Gas Sensor with BLE, Internal antenna, Type AA battery 1.5VDC, IP67,
RC1 zone
Wireless Sigfox Ammonia Gas Sensor with BLE, Internal antenna, Type AA battery 1.5VDC, IP67,
RC2-RC4 zones
RC zones selection 1, 2, 4,... is RCZ1, RCZ2, RCZ4,... (refer to
6)
Refer to register address 8 and 10 (DEC)
FW Ver.
1.0
AUG-2021
section

Advertisement

Table of Contents
loading

Summary of Contents for daviteq WSSFCB-NH3

  • Page 1 USER GUIDE FOR SIGFOX-READY AMMONIA GAS SENSOR WITH BLE WSSFCB-NH3 WSSFC- NH3-MN-EN-01 AUG-2021 This document is applied for the following products WSSFCB-NH3 HW Ver. FW Ver. Wireless Sigfox Ammonia Gas Sensor with BLE, Internal antenna, Type AA battery 1.5VDC, IP67,...
  • Page 2 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.
  • Page 3 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 >...
  • Page 4 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.
  • Page 5 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.
  • Page 6 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...
  • Page 7 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...
  • Page 8 5.3 Device behavior & Firmware Specification of NH3 Sensor sections 5.5 Please read 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.
  • Page 9 Flow when coming from downlink:...
  • Page 10 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.
  • Page 11 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.
  • Page 12: Table Of Contents

    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)
  • Page 13 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.
  • Page 14 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).
  • Page 15 BLE broadcast...
  • Page 16 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.
  • Page 17 Signal received « OK »: Signal received « ALERT 1 »:...
  • Page 18 Signal received « ALERT 2 »: 5.5 Pairing with BLE Indicator Insert battery into Sigfox NH3BLE , wait 1 minute for configuration end , then Sigfox NH3BLE will broadcast BLE data. Then insert battery into BLE Indicator , place it near to Sigfox NH3BLE When BLE Indicator have ID NOT MATCH with ID from Sigfox NH3BLE , buzzer of BLE Indicator will beep 2 times.
  • Page 19 When BLE Indicator have NO ID and received ID from Sigfox NH3BLE , buzzer of BLE Indicator will beep 1 times When BLE Indicator have ID MATCH with ID from Sigfox NH3BLE , BLE Indicator will operation normal (details in Firmware Specifications Sound and light indicator)
  • Page 20: Parameters (Dlk)

    5.7 Configuration Parameters Should not change the value in the Blue cells Length Category Parameter Description Possible values Default value (in bits) Flag to enable/disable 0b0 = false, LEDs are LED and Buzzer DEVICE LED_BUZZER_ENABLE interactions for action 0b0 = false 0b1 = true, LEDs are not triggered by the button.
  • Page 21: Nh3_Alert_Enable

    0b0 = false, NH3 ALERT feature is 0b0 = false, NH3 Enable NH3_ALERT disabled NH3_ALERT ENABLE ALERT feature is event 0b1 = true, NH3 disabled ALERT feature is enabled 8-bit unsigned integer Formula: (8- bit_NH3ppm*2)= real_NH3_level_in_ppm Range: 0 to 100ppm Threshold #1 on the NH3_ALERT1_MAX_THRESHOLD Accuracy: 0.5ppm...
  • Page 22 LATEST_SIGFOX_DOWNLINK Latest received and valid 64-bit encoded field DEVICE sigfox downlink frame See Sigfox Downlink tab 4-bit unsigned integer HW_VERSION = HW_VERSION value in DEVICE HW_VERSION Indicate HW version EEPROM set in production if Value unknown, default value will be 0 8-bit unsigned integer DEVICE FW_VERSION...
  • Page 23 Event Type EVENT_ID HW_NH3_ERROR RESERVED bits Payload data format EVENT_ID HW_NH3_ERROR NH3_FORCE_DATA zeros HW_NH3_ERROR Event Type EVENT_ID RESERVED MIN_NH3 AVG_NH3 MAX_NH3 bits HW_NH3_ERROR Payload data EVENT_ID format zeros HW_NH3_ERROR EXTREME_NH3 ALERT_ Event Type EVENT_ID RESERVED ALERT_TYPE TENTATIVE DURATION bits HW_NH3_ERROR Payload data ALERT_ EVENT_ID...
  • Page 24 Downlink type= 0b0101 5.9 BLE Broadcast Format Size Broadcast EDDYSTONE CURRENT ALERT_TYPE ALERT_ DEVICE_ID Type HEADER CONFIGURATION FLAG_ NH3_ VERSION VERSION reset ERROR 28.0 bits LATEST_ EDDYSTONE Payload ALERT_TYPE ALERT_ DEVICE_ID SIGFOX_ HEADER data FLAG_ NH3_ DOWNLINK NH3 VERSION VERSION format reset ERROR...
  • Page 25 Size Broadcast EDDYSTONE CURRENT ALERT_TYPE ALERT_ DEVICE_ID Type HEADER CONFIGURATION FLAG_ NH3_ VERSION VERSION reset ERROR 28.0 bits LATEST_ EDDYSTONE Payload ALERT_TYPE ALERT_ DEVICE_ID SIGFOX_ HEADER data FLAG_ NH3_ DOWNLINK NH3 VERSION VERSION format reset ERROR Broadcast: ALERT_TYPE 0x0201040303AAFEXX16AAFE20 = 1 or 2 ALERT_FLAG_reset Size Broadcast...
  • Page 26 hardware string Read version device ID Read Product ID device PAC Read Product PAC SENSOR_TYPE Sensor or 1-255 uint16 Read Input Type 6.2 Configuration table Modbus Modbus Function Function Description # of Register Register Code Code Range Default Format Property Comment Registers (Decimal)
  • Page 27 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;...
  • Page 28 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...
  • Page 29 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.
  • Page 30 8.3 Battery installation Steps for battery installation: Step 1: Using M4 Hex key to open the cover...
  • Page 31 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)
  • Page 32 9. Troubleshooting Phenomena Reason Solutions Check that the battery is No power supply or battery empty or not installed Node does not send RF to base ran out correctly station periodically, LED does not Configuration sending Check the power supply blink cycle is incorrect Check the send cycle...
  • Page 33 Insert the battery in the The node does not send RF and wrong direction Check battery polarity the RF module is hot Electronics got problem Distance between Node Check the location of and Base station is far or Sigfox node and distance there are many to the base station RSSI is weak and often loses data...
  • Page 34 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...
  • Page 35 - 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.
  • Page 36 Daviteq Technologies Inc 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 Revision #25 Created Mon, Nov 8, 2021 7:07 AM by Kiệt Anh Nguyễn Updated Tue, Jan 11, 2022 3:46 AM by Kiệt Anh Nguyễn...

Table of Contents