Changes for page CPN01- NB-IoT Outdoor Open/Close Dry Contact Sensor User Manual

Last modified by Mengting Qiu on 2024/04/02 16:56

From version < 37.1 >

edited by Edwin Chen
on 2022/10/22 23:46

To version < 42.1 >

edited by Edwin Chen
on 2022/10/23 00:32

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 1 added, 0 removed)
- image-20221023000439-3.png

Details

Page properties

Content

@@ -7,11 +7,11 @@
  == **1.1 **What is CPN01 **NB-IoT** Pulse/Contact Sensor ==
--The Dragino CPN01 is an (% style="color:blue" %)**NB-IoT Dry Contact Sensor**(%%). It detects open/close status and uplinks the info to IoT server via Nb-IoT network. User can see the (% style="color:blue" %)dry contact status, open time, and open counts(%%) in the IoT Server.
++The Dragino CPN01 is an (% style="color:blue" %)**NB-IoT Dry Contact Sensor**(%%). It detects open/close status and uplinks the info to IoT server via NB-IoT network. User can see the (% style="color:blue" %)**dry contact status, open time, and open counts**(%%) in the IoT Server.
--The CPN01 will send periodically data every day as well as for each dry contact action. It also counts the contact open times and calculates the last open duration. Users can also disable the uplink for each open/close event, instead, device can count each open event and uplink periodically.
++The CPN01 will send periodically data every day as well as for each dry contact action. It also counts the contact open times and calculates the last open duration. Users can also disable the uplink for each Open/Close event, instead, device can count each open event and uplink periodically.
--CPN01 has (% style="color:blue" %)Open-Alarm feature(%%), user can set this feature so CPN01 will send an alarm if the contact has been open exceeds a certain time.
++CPN01 has** (% style="color:blue" %)Open-Alarm feature(%%)**, user can set this feature so CPN01 will send an alarm if the contact has been open exceeds a certain time.
  CPN01 is designed for outdoor use. It has a weatherproof enclosure and industrial-level battery to work in low to high temperatures.
@@ -57,12 +57,13 @@
  == **1.4 Installation** ==
--Connect CPL01 to an Open Close sensor like below. So it can detect the open/close event.
++Connect CPN01 to an Open Close sensor like below. So it can detect the Open/Close event.
  [[image:image-20221021110329-1.png]]
--[[image:image-20221021110340-2.png]]
++[[image:image-20221022234602-2.png||height="288" width="922"]]
++
  == **1.5 Applications** ==
  * Open/Close Detection
@@ -79,35 +79,32 @@
  === **1.7.1 Pin Definition** ===
--CPL01 is pre-configured to connect to two external wires. The other pins are not used. If user wants to know more about other pins, please refer to the user manual of LSN50v2 at: [[https:~~/~~/www.dropbox.com/sh/djkxs7mr17y94mi/AABVlWbM9uzK9OA3mXyAT10Za?dl=0>>url:https://www.dropbox.com/sh/djkxs7mr17y94mi/AABVlWbM9uzK9OA3mXyAT10Za?dl=0]]
++CPN01 is pre-configured to connect to two external wires. The other pins are not used. If user wants to know more about other pins, please refer to the **[[LSN50v2 User Manual>>doc:Main.User Manual for LoRaWAN End Nodes.LSN50 & LSN50-V2 - LoRaWAN Sensor Node User Manual.WebHome]]**.
++
  === **1.7.2 Jumper JP2(Power ON/OFF)** ===
--
  Power on Device when putting this jumper.
--
  === **1.7.3 BOOT MODE / SW1** ===
--1) ISP: upgrade mode, device won't have any signal in this mode. but ready for upgrade firmware. LED won't work. Firmware won't run.
++1) ISP: upgrade mode, device won't have any signal in this mode. but ready for upgrade firmware. LED won't work. The firmware won't run.
--2) Flash: work mode, the device starts to work and send out console output for further debug
++2) Flash: working mode, the device starts to work for NB-IoT connection and sends out console output for further debugging.
--
  === **1.7.4 Reset Button** ===
  Press to reboot the device.
--==   ==
  === **1.7.5 LED** ===
--It will flash:
++The LED will blink when :
 . Boot the device in flash mode
 . Send an uplink packet
@@ -116,36 +116,40 @@
  == **2.1  How it works** ==
--The CPN01 is equipped with a NB-IoT module, the pre-loaded firmware in CPN01 will get environment data from sensors and send the value to local NB-IoT network via the NB-IoT module.  The NB-IoT network will forward this value to IoT server via the protocol defined by CPN01.
++The CPN01 is equipped with an NB-IoT module, the pre-loaded firmware in CPN01 will get **Open/Close Event or Count** from sensor and send the value to the NB-IoT network. The NB-IoT network will forward this value to IoT server via the protocol defined by CPN01.
--The diagram below shows the working flow in default firmware of CPN01:
++The diagram below shows the working flow in the default firmware of CPN01:
  [[image:image-20221021110615-5.png]]
--== **2.2  Configure the CPN01** ==
++== **2.2  Configure CPN01** ==
++
  === **2.2.1  Test Requirement** ===
--To use CPN01 in your city, make sure meet below requirements:
++To use CPN01 in your city, make sure to meet below requirements:
--* Your local operator has already distributed a NB-IoT Network there.
++* Your local operator has already distributed an NB-IoT Network.
  * The local NB-IoT network used the band that CPN01 supports.
  * Your operator is able to distribute the data received in their NB-IoT network to your IoT server.
--Below figure shows our testing structure.   Here we have NB-IoT network coverage by China Mobile, the band they use is B8.  The CPN01 will use CoAP(120.24.4.116:5683) or raw UDP(120.24.4.116:5601) or MQTT(120.24.4.116:1883)or TCP(120.24.4.116:5600)protocol to send data to the test server
++Below figure shows our testing structure. Here we have NB-IoT network coverage by China Mobile, the band they use is B8.  The CPN01 will use CoAP(120.24.4.116:5683) or raw UDP(120.24.4.116:5601) or MQTT(120.24.4.116:1883)or TCP(120.24.4.116:5600)protocol to send data to the test server.
++[[image:image-20221023000439-3.png]]
++
--=== **2.2.2  Insert SIM card** ===
++=== **2.2.2  Insert NB-IoT SIM card** ===
  Insert the NB-IoT Card get from your provider.
--User need to take out the NB-IoT module and insert the SIM card like below:
++User needs to take out the NB-IoT module and insert the SIM card like below:
  [[image:image-20221021110745-6.png]]
--=== **2.2.3  Connect USB – TTL to CPN01 to configure it** ===
++=== **2.2.3  Connect USB – TTL to CPN01 and configure it** ===
++
  User need to configure CPN01 via serial port to set the **Server Address** / **Uplink Topic** to define where and how-to uplink packets. CPN01 support AT Commands, user can use a USB to TTL adapter to connect to CPN01 and use AT Commands to configure it, as below.
  **Connection:**
@@ -164,36 +164,44 @@
  * Parity:      **None**
  * Flow Control: **None**
--Make sure the switch is in FLASH position, then power on device by connecting the jumper on CPN01. CPN01 will output system info once power on as below, we can enter the **password: 12345678** to access AT Command input.
++Make sure the switch is in FLASH position, then power on CPN01 by connecting the (% style="color:orange" %)**Yellow Jumper**(%%).
  [[image:image-20221021110817-7.png]]
++CPN01 will output system info once powered on as below, we can enter the **password: 12345678** to access AT Command input.
++
++
  **Note: the valid AT Commands can be found at:  **[[**https:~~/~~/www.dropbox.com/sh/351dwor6joz8nwh/AADn1BQaAAxLF_QMyU8NkW47a?dl=0**>>url:https://www.dropbox.com/sh/351dwor6joz8nwh/AADn1BQaAAxLF_QMyU8NkW47a?dl=0]]
++
  === **2.2.4  Use CoAP protocol to uplink data** ===
--**Note: if you don't have CoAP server, you can refer this link to set up one: **[[**http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/Set%20up%20CoAP%20Server/**>>url:http://wiki.dragino.com/xwiki/bin/view/Main/Set%20up%20CoAP%20Server/]]
++**Note: if you don't have a CoAP server, you can refer this link to set up a CoAP server: **[[**http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/Set%20up%20CoAP%20Server/**>>url:http://wiki.dragino.com/xwiki/bin/view/Main/Set%20up%20CoAP%20Server/]]
--**Use below commands:**
++**Use below commands in CPN01:**
++
  * **AT+PRO=1**                                               ~/~/ Set to use CoAP protocol to uplink
--* **AT+SERVADDR=120.24.4.116,5683   **  ~/~/ to set CoAP server address and port
--* **AT+URI=5,11,"mqtt",11,"coap",12,"0",15,"c=text1",23,"0" **       ~/~/Set COAP resource path
++* **AT+SERVADDR=120.24.4.116,5683   **     ~/~/ Set CoAP server address and port
++* **AT+URI=5,11,"mqtt",11,"coap",12,"0",15,"c=text1",23,"0" **       ~/~/Set CoAP resource path
  For parameter description, please refer to AT command set
  [[image:image-20221021110948-8.png]]
--After configure the server address and **reset the device** (via AT+ATZ ), CPN01 will start to uplink sensor values to CoAP server.
++After configuring the server address and **reset CPN01** (via AT+ATZ ), CPN01 will start to uplink sensor values to the CoAP server.
++
  [[image:image-20221021110956-9.png]]
++
  === **2.2.5  Use UDP protocol to uplink data(Default protocol)** ===
--This feature is supported since firmware version v1.0.1
++**AT Commands:**
++
  * **AT+PRO=2   **  ~/~/ Set to use UDP protocol to uplink
--* **AT+SERVADDR=120.24.4.116,5601   **   ~/~/ to set UDP server address and port
++* **AT+SERVADDR=120.24.4.116,5601   **   ~/~/ Set UDP server address and port
  * **AT+CFM=1       **    ~/~/If the server does not respond, this command is unnecessary
   [[image:image-20221021111025-10.png]]
@@ -204,8 +204,9 @@
  === **2.2.6  Use MQTT protocol to uplink data** ===
--This feature is supported since firmware version v110
++**AT Commands:**
++
  * **AT+PRO=3   **                                              ~/~/Set to use MQTT protocol to uplink
  * **AT+SERVADDR=120.24.4.116,1883   **      ~/~/Set MQTT server address and port
  * **AT+CLIENT=CLIENT       **                           ~/~/Set up the CLIENT of MQTT
@@ -220,14 +220,15 @@
--MQTT protocol has a much higher power consumption compare vs UDP / CoAP protocol. Please check the power analyze document and adjust the uplink period to a suitable interval.
++MQTT protocol has a much higher power consumption compare with UDP / CoAP protocol. Please check the power analyze document and adjust the uplink period to a suitable interval.
++
  === **2.2.7  Use TCP protocol to uplink data** ===
--This feature is supported since firmware version v110
++**AT Commands**
  * **AT+PRO=4   **                                           ~/~/ Set to use TCP protocol to uplink
--* **AT+SERVADDR=120.24.4.116,5600   ** ~/~/ to set TCP server address and port
++* **AT+SERVADDR=120.24.4.116,5600   **    ~/~/ Set TCP server address and port
   [[image:image-20221021111125-14.png]]
@@ -239,15 +239,16 @@
  User can use below command to change the **uplink interval**.
--* **AT+TDC=600      **  ~/~/ Set Update Interval to 600s
++* **AT+TDC=7200      **  ~/~/ Set Update Interval to 7200s (2 hours)
  **NOTE:**
  **~1. By default, the device will send an uplink message every 1 hour.**
++
  == **2.3  Uplink Payload** ==
--In this mode, uplink payload includes 87 bytes in total by default.
++The uplink payload includes 87 bytes in total by default.
  Each time the device uploads a data package, 8 sets of recorded data will be attached. Up to 32 sets of recorded data can be uploaded.
@@ -276,9 +276,9 @@
  *(% style="color:#037691" %) **Mod:**(%%) 0x01 = 1
--*(% style="color:#037691" %) **Calculate Flag:**(%%) 0x00= 0
++*(% style="color:#037691" %) **Calculate Flag:**(%%) 0x00=0
--*(% style="color:#037691" %) **Contact Status:**(%%) 0x00= 0
++*(% style="color:#037691" %) **Contact Status:**(%%) 0x00=0
  *(% style="color:#037691" %) **Alarm:**(%%)0x00 =0
@@ -286,17 +286,18 @@
  *(% style="color:#037691" %) **The last open duration:**(%%)0x02 =2
--*(% style="color:#037691" %)**Time stamp :**(%%) 0x6315537b =1662342011
++*(% style="color:#037691" %)** Time stamp :**(%%) 0x6315537b =1662342011 (Unix Time)
  *(% style="color:#037691" %) **Contact Status, Total pulse, Calculate Flag, The last open duration ,Time stamp :**(%%) 0100000b0200002663510fed
  *(% style="color:#037691" %) **8 sets of recorded data: Contact Status, Total pulse, Calculate Flag, The last open duration ,Time stamp :**(%%) 0100000e0200002663510f39,.......
++
  == **2.4  Payload Explanation and Sensor Interface** ==
  === **2.4.1  Device ID** ===
--By default, the Device ID equal to the last 15 bits of IMEI.
++By default, the Device ID is equal to the last 15 bits of IMEI.
  User can use **AT+DEUI** to set Device ID
@@ -304,14 +304,16 @@
  AT+DEUI=868411056754138
--The Device ID is stored in a none-erase area, Upgrade the firmware or run AT+FDR won't erase Device ID.
++The Device ID is stored in a non-erase area, Upgrade the firmware or run AT+FDR won't erase the Device ID.
++
  === **2.4.2  Version Info** ===
--Specify the software version: 0x64=100, means firmware version 1.00.
++Specify the software version: 0x64=100, which means firmware version 1.00.
--For example: 0x00 64 : this device is CPN01 with firmware version 1.0.0.
++For example 0x00 64 : This device is CPN01 with firmware version 1.0.0.
++
  === **2.4.3  Battery Info** ===
  Check the battery voltage for CPN01.
@@ -320,6 +320,7 @@
  Ex2: 0x0B49 = 2889mV
++
  === **2.4.4  Signal Strength** ===
  NB-IoT Network signal Strength.
@@ -336,9 +336,10 @@
  **99**      Not known or not detectable
++
  === **2.4.5 Calculate Flag** ===
--The calculate flag is a user define field, IoT server can use this filed to handle different meter with different pulse factor. For example, if there are 100 water meters, meter 1 ~~50 are 1 liter/pulse and meter 51 ~~ 100 has 1.5 liter/pulse.
++The calculate flag is a user defined field, IoT server can use this filed to handle different meters with different pulse factors. For example, if there are 100 water meters, meter 1~~50 are 1 liter/pulse and meter 51 ~~ 100 has 1.5 liter/pulse.
  User can set calculate flag to 1 for meter 1~~50 and 2 for meter 51 ~~ 100, So IoT Server can use this field for calculation.
@@ -346,10 +346,12 @@
  Range (6 bits): (b)000000 ~~ (b) 111111
++
  === **2.4.6   Alarm** ===
  See [[Alarm Base on Timeout>>url:http://wiki.dragino.com/xwiki/bin/view/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/CPL01%20LoRaWAN%20Outdoor%20PulseContact%20%20Sensor%20Manual/#H3.5AlarmBaseonTimeout]]
++
  === **2.4.7 Contact Status** ===
 : Open
@@ -356,12 +356,14 @@
 : Close
++
  === **2.4.8 Total pulse** ===
--Total pulse/counting base on dry [[contact trigger event>>url:http://wiki.dragino.com/xwiki/bin/view/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/CPL01%20LoRaWAN%20Outdoor%20PulseContact%20%20Sensor%20Manual/#H2.3.2SensorConfiguration2CFPORT3D4]]
++Total pulse/counting based on dry [[contact trigger event>>url:http://wiki.dragino.com/xwiki/bin/view/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/CPL01%20LoRaWAN%20Outdoor%20PulseContact%20%20Sensor%20Manual/#H2.3.2SensorConfiguration2CFPORT3D4]]
  Range (3 Bytes) : 0x000000 ~~ 0xFFFFFF . Max: 16777215
++
  === **2.4.9 The last open duration** ===
  Dry Contact last open duration.
@@ -373,7 +373,7 @@
  === **2.4.10  Timestamp** ===
--Time stamp : 0x6315537b =1662342011
++Timestamp : 0x6315537b =1662342011
  Convert Unix timestamp to time 2022-9-5 9:40:11.
@@ -405,7 +405,7 @@
  == **2.6  LED Indicator** ==
--The CPN01 has an internal LED which is to show the status of different state.
++The CPN01 has an internal LED which is to show the status of different states.
  * When power on, CPN01 will detect if sensor probe is connected, if probe detected, LED will blink four times. (no blinks in this step is no probe)
  * Then the LED will be on for 1 second means device is boot normally.
@@ -412,9 +412,10 @@
  * After CPN01 join NB-IoT network. The LED will be ON for 3 seconds.
  * For each uplink probe, LED will be on for 500ms.
++
  == **2.7  Alarm Base on Timeout** ==
--CPL01 can monitor the timeout for a status change, this feature can be used to monitor some events such as door opening too long etc. Related Parameters are:
++CPN01 can monitor the timeout for a status change, this feature can be used to monitor some events such as door opening too long etc. Related Parameters are:
  **~1. Keep Status: Status to be monitor**
@@ -435,10 +435,11 @@
  **AT Command** to configure:
--**AT+TTRIG=1,30**   ~-~-> When the **Keep Status** change from connect to disconnect, and device remains in disconnect status for more than 30 seconds. CPL01 will send an uplink packet, the [[Alarm bit>>url:http://wiki.dragino.com/xwiki/bin/view/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/CPL01%20LoRaWAN%20Outdoor%20PulseContact%20%20Sensor%20Manual/#H2.3.3Real-TimeOpen2FCloseStatus2CUplinkFPORT3D2]] (the second bit of 1^^st^^ byte of payload) on this uplink packet is set to 1.
++**AT+TTRIG=1,30**   ~-~-> When the **Keep Status** change from connected to disconnect, and device remains in disconnect status for more than 30 seconds. CPN01 will send an uplink packet, the [[Alarm bit>>url:http://wiki.dragino.com/xwiki/bin/view/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/CPL01%20LoRaWAN%20Outdoor%20PulseContact%20%20Sensor%20Manual/#H2.3.3Real-TimeOpen2FCloseStatus2CUplinkFPORT3D2]] (the second bit of 1^^st^^ byte of payload) on this uplink packet is set to 1.
  **AT+TTIG=0,0 **      ~-~-> Default Value, disable timeout Alarm.
++
  == **2.8 Set debug mode** ==
  Feature: Enable or Disable debug mode
@@ -510,11 +510,11 @@
  === **2.16.1  Battery Type** ===
--The CPN01 battery is a combination of an 8500mAh Li/SOCI2 Battery and a Super Capacitor. The battery is none-rechargeable battery type with a low discharge rate (<2% per year). This type of battery is commonly used in IoT devices such as water meter.
++The CPN01 battery is a combination of an 8500mAh Li/SOCI2 Battery and a Super Capacitor. The battery is non-rechargeable battery type with a low discharge rate (<2% per year). This type of battery is commonly used in IoT devices such as water meter.
--The battery is designed to last for several years depends on the actually use environment and update interval.
++The battery is designed to last for several years depends on the actual use environment and update interval.
--The battery related documents as below:
++The battery-related documents as below:
  * [[Battery Dimension>>url:http://www.dragino.com/downloads/index.php?dir=datasheet/Battery/ER26500/]]
  * [[Lithium-Thionyl Chloride Battery datasheet>>url:http://www.dragino.com/downloads/index.php?dir=datasheet/Battery/ER26500/]]
@@ -548,6 +548,7 @@
  The default battery pack of CPN01 includes a ER26500 plus super capacitor. If user can't find this pack locally, they can find ER26500 or equivalence without the SPC1520 capacitor, which will also work in most case. The SPC can enlarge the battery life for high frequency use (update period below 5 minutes).
++
  = **3.  Access NB-IoT Module** =
  Users can directly access the AT command set of the NB-IoT module.
@@ -647,12 +647,10 @@
  Please see this link for how to upgrade:  [[http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/Firmware%20Upgrade%20Instruction%20for%20STM32%20base%20products/#H2.HardwareUpgradeMethodSupportList>>url:http://wiki.dragino.com/xwiki/bin/view/Main/Firmware%20Upgrade%20Instruction%20for%20STM32%20base%20products/#H2.HardwareUpgradeMethodSupportList]]
--**Notice, **CPN01 **and **CPN01 **share the same mother board. They use the same connection and method to update.**
++**Notice, **CPN01 **and **CPL01 **share the same mother board. They use the same connection and method to update.**
--== **5.2  Can I calibrate CPN01 to different soil types?** ==
++
--CPN01 is calibrated for saline-alkali soil and loamy soil. If users want to use it for other soil, they can calibrate the value in the IoT platform base on the value measured by saline-alkali soil and loamy soil. The formula can be found at [[this link>>url:https://www.dragino.com/downloads/downloads/LoRa_End_Node/LSE01/Calibrate_to_other_Soil_20220605.pdf]].
--
  = **6.  Trouble Shooting** =
  == **6.1  Connection problem when uploading firmware** ==
@@ -659,19 +659,22 @@
  **Please see: **[[http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/Firmware%20Upgrade%20Instruction%20for%20STM32%20base%20products/#H3.3Troubleshooting>>url:http://wiki.dragino.com/xwiki/bin/view/Main/Firmware%20Upgrade%20Instruction%20for%20STM32%20base%20products/#H3.3Troubleshooting]]
++
  == **6.2  AT Command input doesn't work** ==
  In the case if user can see the console output but can't type input to the device. Please check if you already include the **ENTER** while sending out the command. Some serial tool doesn't send **ENTER** while press the send key, user need to add ENTER in their string.
++
  = **7.  Order Info** =
  Part Number**:** CPN01
++
  = **8.  Packing Info** =
  **Package Includes**:
--* CPN01 NB-IoT Soil Moisture & EC Sensor x 1
++* CPN01 Open/Close Sensor x 1
  * External antenna x 1
  **Dimension and weight**:

image-20221023000439-3.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.Edwin

Size

...	...	@@ -1,0 +1,1 @@
	1	+82.1 KB

Content

Changes for page CPN01- NB-IoT Outdoor Open/Close Dry Contact Sensor User Manual

Summary

Details

Applications

Navigation