CPL03-NB -- NB-IoT Pulse Contact Sensor User Manual
Table of Contents:
- 1. Introduction
- 2. Use CPL03-NB to communicate with IoT Server
- 2.1 Send data to IoT server via NB-IoT network
- 2.2 Payload Types
- 2.3 Uplink Payload
- 2.4 Test Uplink and Change Update Interval
- 2.5 Multi-Samplings and One uplink
- 2.6 Trggier an uplink by external interrupt
- 2.7 Enable / Disable Alarm
- 2.8 Alarm Base on Timeout
- 2.9 TTRIG timeout status alarm
- 2.10 Set trigger mode of PA8
- 2.11 Set trigger mode of PA4
- 2.12 Set trigger mode of PB15
- 2.13 Set the calculate flag
- 2.14 Set count number
- 2.15 Clear all counter values
- 2.16 Count Mod
- 2.17 Work Mod
- 2.18 Clock logging (Since firmware version v1.2.1)
- 2.19 Example Query saved historical records
- 2.20 Uplink log query
- 2.21 Scheduled domain name resolution
- 2.22 Set the QoS level
- 2.23 Set the downlink debugging mode(Since firmware v1.3.0)
- 2.24 Domain name resolution settings(Since firmware v1.3.0)
- 3. Configure CPL03-NB
- 4. Battery & Power Consumption
- 5. Firmware update
- 6. FAQ
- 7. Order Info
- 8. Packing Info
- 9. Support
1. Introduction
1.1 What is CPL03-NB NB-IoT Pulse/Contact Sensor
The Dragino CPL03-NB is a NB-IoT Contact Sensor for Internet of Things solution. It detects dry contact status, open time, open counts, and then upload to IoT server via NB-IoT network.
The CPL03-NB will send periodically data every day as well as for each dry contact action. It also counts the contact open times and calculate last open duration. User can also disable the uplink for each open/ close event, instead, device can count each open event and uplink periodically.
CPL03-NB supports open alarm feature, user can set open alarm for instant notice. CPL03-NB supports Datalog feature, it can save the data when there is no NB-IoT network and uplink when network recover.
CPL03-NB is designed for outdoor use. It has a weatherproof enclosure and industrial level battery to work in low to high temperatures.
CPL03-NB supports different uplink methods including MQTT, MQTTs, UDP & TCP for different application requirement, and support uplinks to various IoT Servers.
CPL03-NB supports BLE configure and OTA update which make user easy to use.
CPL03-NB is powered by 8500mAh Li-SOCI2 battery, it is designed for long-term use up to several years.
CPL03-NB has optional built-in SIM card and default IoT server connection version. Which makes it works with simple configuration.
1.2 Features
- NB-IoT Bands: B1/B2/B3/B4/B5/B8/B12/B13/B17/B18/B19/B20/B25/B28/B66/B70/B85 @H-FDD
- Ultra-low power consumption
- Upload water flow volume
- Door Open/Close detect
- Door open/close statistics
- Datalog Feature
- Open Alarm Feature
- Multiply Sampling and one uplink
- Support Bluetooth v5.1 remote configure and update firmware
- Uplink on periodically
- Downlink to change configure
- 8500mAh Battery for long term use
- Nano SIM card slot for NB-IoT SIM
1.3 Specification
Common DC Characteristics:
- Supply Voltage: 2.5v ~ 3.6v
- Operating Temperature: -40 ~ 85°C
NB-IoT Spec:
NB-IoT Module: BC660K-GL
Support Bands:
- B1 @H-FDD: 2100MHz
- B2 @H-FDD: 1900MHz
- B3 @H-FDD: 1800MHz
- B4 @H-FDD: 2100MHz
- B5 @H-FDD: 860MHz
- B8 @H-FDD: 900MHz
- B12 @H-FDD: 720MHz
- B13 @H-FDD: 740MHz
- B17 @H-FDD: 730MHz
- B18 @H-FDD: 870MHz
- B19 @H-FDD: 870MHz
- B20 @H-FDD: 790MHz
- B25 @H-FDD: 1900MHz
- B28 @H-FDD: 750MHz
- B66 @H-FDD: 2000MHz
- B70 @H-FDD: 2000MHz
- B85 @H-FDD: 700MHz
Battery:
- Li/SOCI2 un-chargeable battery
- Capacity: 8500mAh
- Self Discharge: <1% / Year @ 25°C
- Max continuously current: 130mA
- Max boost current: 2A, 1 second
Power Consumption
- STOP Mode: 10uA @ 3.3v
- Max transmit power: 350mA@3.3v
1.4 Applications
- Open/Close Detection
- Pulse meter application
- Dry Contact Detection
1.5 Sleep mode and working mode
Deep Sleep Mode: Sensor doesn't have any NB-IoT activate. This mode is used for storage and shipping to save battery life.
Working Mode: In this mode, Sensor will work as NB-IoT Sensor to Join NB-IoT network and send out sensor data to server. Between each sampling/tx/rx periodically, sensor will be in IDLE mode), in IDLE mode, sensor has the same power consumption as Deep Sleep mode.
1.6 Button & LEDs
Behavior on ACT | Function | Action |
---|---|---|
Pressing ACT between 1s < time < 3s | Send an uplink | If sensor has already attached to NB-IoT network, sensor will send an uplink packet, blue led will blink once. |
Pressing ACT for more than 3s | Active Device | Green led will fast blink 5 times, device will enter OTA mode for 3 seconds. And then start to attach NB-IoT network. |
Fast press ACT 5 times. | Deactivate Device | Red led will solid on for 5 seconds. Means device is in Deep Sleep Mode. |
Note: When the device is executing a program, the buttons may become invalid. It is best to press the buttons after the device has completed the program execution.
1.7 BLE connection
CPL03-NB support BLE remote configure and firmware update.
BLE can be used to configure the parameter of sensor or see the console output from sensor. BLE will be only activate on below case:
- Press button to send an uplink
- Press button to active device.
- Device Power on or reset.
If there is no activity connection on BLE in 60 seconds, sensor will shut down BLE module to enter low power mode.
1.8 Pin Definitions , Switch & SIM Direction
1.8.1 Jumper JP2
Power on Device when put this jumper.
1.8.2 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.
2) Flash: work mode, device starts to work and send out console output for further debug
1.8.3 Reset Button
Press to reboot the device.
1.8.4 SIM Card Direction
See this link. How to insert SIM Card.
1.9 Mechanical
2. Use CPL03-NB to communicate with IoT Server
2.1 Send data to IoT server via NB-IoT network
The CPL03-NB is equipped with a NB-IoT module, the pre-loaded firmware in CPL03-NB 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 CPL03-NB.
Below shows the network structure:
There are two version: -GE and -1D version of CPL03-NB.
GE Version: This version doesn't include SIM card or point to any IoT server. User needs to use AT Commands to configure below two steps to set CPL03-NB send data to IoT server.
- Install NB-IoT SIM card and configure APN. See instruction of Attach Network.
- Set up sensor to point to IoT Server. See instruction of Configure to Connect Different Servers.
Below shows result of different server as a glance.
Servers | Dash Board | Comments |
Node-Red | ||
DataCake | ||
Tago.IO | ||
General UDP | Raw Payload. Need Developer to design Dash Board | |
General MQTT | Raw Payload. Need Developer to design Dash Board | |
ThingSpeak | ||
ThingsBoard |
1D Version: This version has 1NCE SIM card pre-installed and configure to send value to DataCake. User Just need to select the sensor type in DataCake and Activate CPL03-NB and user will be able to see data in DataCake. See here for DataCake Config Instruction.
2.2 Payload Types
To meet different server requirement, CPL03-NB supports different payload type.
Includes:
- General JSON format payload. (Type=5)
- HEX format Payload. (Type=0)
- ThingSpeak Format. (Type=1)
- ThingsBoard Format. (Type=3)
User can specify the payload type when choose the connection protocol. Example:
AT+PRO=2,0 // Use UDP Connection & hex Payload
AT+PRO=2,5 // Use UDP Connection & Json Payload
AT+PRO=3,5 // Use MQTT Connection & Json Payload
2.2.1 General Json Format(Type=5)
2.2.1.1 AT+MOD=1(Real-Time Open/Close Status)
{"IMEI":"863663062798914","IMSI":"460083513507314","Model":"CPL03-NB","work mode":1,"count_mode":0,"tdc send flag":1,"trigger mode":0,"alarm":0,"pa8 level status":1,"count time":0,"door duration":0,"battery":3.22,"signal":15,"time":"2024/11/20 03:49:34","1":[0,0,0,0,0,61441,0,"2024/11/20 02:03:04"],"2":[0,0,0,0,0,192513,0,"2024/11/14 10:00:21"],"3":[0,0,0,0,0,192513,0,"2024/11/14 09:59:21"],"4":[0,0,0,0,0,192513,0,"2024/11/14 09:58:21"],"5":[0,0,0,0,0,192513,0,"2024/11/14 09:57:21"],"6":[0,0,0,0,0,126977,0,"2024/11/14 09:56:21"],"7":[0,0,0,0,0,126977,0,"2024/11/14 09:55:21"],"8":[0,0,0,0,0,126977,0,"2024/11/14 09:54:21"]}
Notice, from above payload:
- work mode, count_mode, tdc_send flag, trigger mode, alarm, pa8 level status, count time, door duration, Battery, Signal & time are the value at uplink time.
- Json entry 1 ~ 8 are the last 1 ~ 8 sampling data as specify by AT+CLOCKLOG=1,65535,15,8 Command. Each entry includes (from left to right): count_mode, tdc_send flag, trigger mode, alarm, pa8 level status, count time, door durationv & Sampling time.
Count mod: Default=0
0: Uplink total open door times since factory
1 : Uplink total open door times since last FPORT=2 uplink.
- TDC send flag
When the flag is 1, it means sending packets at normal time intervals.
Otherwise, it is a packet sent at non-TDC time.
- Work mod
0: CPL03-NB-Real-Time Open/Close Status mode.
1: CPL03-NB-3 pulse mode.
- Trigger mod
0: The pulse count will increment by one after a close to open event and the last duration is for the open event.
1: The pulse count will increment by one after a open to close event and the last duration is for the close event.
Alarm
- pa8 level status
0: The PA8 pin level is low.
1: The PA8 pin level is high.
count time
Total pulse/counting base on dry contact trigger event
Range (3 Bytes) : 0x000000 ~ 0xFFFFFF . Max: 16777215
Door duration
1) AT+TTRMOD1=0 : Dry Contact last open duration.(Unit: sec)
2) AT+TTRMOD1=1 : Dry Contact last close duration.(Unit: sec)
2.2.1.2 AT+MOD=2(3 pulse mode)
{"IMEI":"863663062798914","IMSI":"460083513507314","Model":"CPL03-NB","work mode":2,"calc flag":0,"count_mode":0,"tdc send flag":1,"count time1":0,"count time2":0,"count time3":0,"battery":3.22,"signal":18,"time":"2024/11/20 03:53:56","1":[0,0,16319072,200,300,"2024/11/20 02:03:04"],"2":[0,0,16253640,200,300,"2024/11/14 10:00:21"],"3":[0,0,16253640,200,300,"2024/11/14 09:59:21"],"4":[0,0,16253637,200,300,"2024/11/14 09:58:21"],"5":[0,0,16253650,200,300,"2024/11/14 09:57:21"],"6":[0,0,16188111,200,300,"2024/11/14 09:56:21"],"7":[0,0,16253636,200,300,"2024/11/14 09:55:21"],"8":[0,0,16319167,200,300,"2024/11/14 09:54:21"]}
Notice, from above payload:
- work mode, calc flag, count_mode, tdc send flag, count time1, count time2, count time3, Battery, Signal & time are the value at uplink time.
- Json entry 1 ~ 8 are the last 1 ~ 8 sampling data as specify by AT+NOUD=8 Command. Each entry includes (from left to right): calc flag, count_mode, count time1, count time2, count time3, Sampling time.
Max COUNT for each port is 16777215. Exceed this number will reset to 1.
Count mod:Default=0
0: Uplink total open door times since factory
1 : Uplink total open door times since last FPORT=2 uplink.
- TDC send flag
When the flag is 1, it means sending packets at normal time intervals.
Otherwise, it is a packet sent at non-TDC time.
- Work mod
0: Real-Time Open/Close Status mode.
1: 3 x pulse counting mode.
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.
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.
Default value: 0.
Range (3 bits): (b)000 ~ (b) 111
Refer: Set Calculate Flag
Port1 Total Pulse(PA8 of pin)
Range (3 Bytes) : 0x000000 ~ 0xFFFFFF . Max: 16777215.Exceed this number will reset to 1.
Port2 Total Pulse(PA4 of pin)
Range (3 Bytes) : 0x000000 ~ 0xFFFFFF . Max: 16777215.Exceed this number will reset to 1.
Port3 Total Pulse(PB15 of pin)
Range (3 Bytes) : 0x000000 ~ 0xFFFFFF . Max: 16777215.Exceed this number will reset to 1.
2.2.2 HEX format Payload(Type=0)
2.2.2.1 AT+MOD=1(Real-Time Open/Close Status)
f863663062798914f46008351350731413820c9b0f11000000000000673d5b5e0000f001000000673d43580002f0010000006735ca350002f0010000006735c9f90002f0010000006735c9bd0002f0010000006735c9810001f0010000006735c9450001f0010000006735c9090001f0010000006735c8cd
If we use the MQTT client to subscribe to this MQTT topic, we can see the following information when the NB sensor uplink data.
Version:
These bytes include the hardware and software version.
Higher byte: Specify Sensor Model: 0x00 for CPL03-NB
Lower byte: Specify the software version: 0x82=130, means firmware version 1.3.0
BAT (Battery Info):
Ex1: 0x0dda = 3546mV
Signal Strength:
NB-IoT Network signal Strength.
Ex1: 0x15 = 21
0 -113dBm or less
1 -111dBm
2...30 -109dBm... -53dBm
31 -51dBm or greater
99 Not known or not detectable
PA8 Status:
PA8 Status consists of Count mode, TDC send flag, Trigger mode, PA8 alarm status, PA8 level status.
(PA8 level Status=(count_mode<<5) | (tdc_send_flag<<4) | (0<<3) | (trigger_mode[0]<<2) | (pa8_alarm_status<<1) | pa8_level_status)
Timestamp:
Unit Timestamp Example: 650abc40(H) = 1695202368(D)
Put the decimal value into this link(https://www.epochconverter.com)) to get the time.
2.2.2.2 AT+MOD=2(3 pulse mode)
f863663062798914f46008351350731413820ca31218000000000000000000673d5ea500f902600000c800012c673d435800f802c80000c800012c6735ca3500f802c80000c800012c6735c9f900f802c50000c800012c6735c9bd00f802d20000c800012c6735c98100f702cf0000c800012c6735c94500f802c40000c800012c6735c90900f902bf0000c800012c6735c8cd
If we use the MQTT client to subscribe to this MQTT topic, we can see the following information when the NB sensor uplink data.
Version:
These bytes include the hardware and software version.
Higher byte: Specify Sensor Model: 0x00 for CPL03-NB
Lower byte: Specify the software version: 0x82=130, means firmware version 1.3.0
BAT (Battery Info):
Ex1: 0x0dda = 3546mV
Signal Strength:
NB-IoT Network signal Strength.
Ex1: 0x15 = 21
0 -113dBm or less
1 -111dBm
2...30 -109dBm... -53dBm
31 -51dBm or greater
99 Not known or not detectable
PA8 Status:
PA8 Status consists of Count mode, TDC send flag, Calculate flag.
(PA8 level Status=(count_mode<<5) | (tdc_send_flag<<4) | (1<<3) |calculate_flag)
Timestamp:
Unit Timestamp Example: 650abc40(H) = 1695202368(D)
Put the decimal value into this link(https://www.epochconverter.com)) to get the time.
2.2.3 ThingsBoard Payload(Type=3)
Type3 payload special design for ThingsBoard, it will also configure other default server to ThingsBoard.
2.2.3.1 AT+MOD=1(Real-Time Open/Close Status)
{
"topic": "2276492",
"payload": {
"IMEI": "863663062798914",
"Model": "CPL03-NB",
"work mode": 1,
"count_mode": 0,
"tdc send flag": 1,
"trigger mode": 1,
"alarm": 0,
"pa8 level status": 1,
"count time": 10,
"door duration": 0,
"battery": 3.28,
"signal": 23,
"1": [0, 0, 0, 1, 1, 0, 0, "2024/05/30 06:53:03"],
"2": [0, 0, 0, 1, 1, 0, 0, "2024/05/30 06:52:28"],
"3": [0, 0, 0, 0, 0, 0, 0, "2024/05/30 06:51:03"],
"4": [0, 0, 0, 0, 0, 0, 0, "2024/05/30 06:50:03"],
"5": [0, 0, 0, 0, 0, 0, 0, "2024/05/30 06:44:34"],
"6": [0, 0, 0, 0, 0, 0, 0, "2024/05/30 06:43:10"],
"7": [0, 0, 0, 1, 1, 10, 0, "2024/05/30 06:40:12"],
"8": [0, 0, 0, 1, 1, 10, 0, "2024/05/30 06:39:12"]
}
}
2.2.3.2 AT+MOD=2(3 pulse mode)
{
"topic": "2276492",
"payload": {
"IMEI": "863663062798914",
"Model": "CPL03-NB",
"work mode": 2,
"calc flag": 0,
"count_mode": 0,
"tdc send flag": 1,
"count time1": 10,
"count time2": 18,
"count time3": 10,
"battery": 3.26,
"signal": 20,
"1": [0, 0, 10, 18, 10, "2024/05/30 06:44:34"],
"2": [0, 0, 10, 18, 10, "2024/05/30 06:43:10"],
"3": [0, 0, 10, 18, 10, "2024/05/30 06:40:12"],
"4": [0, 0, 10, 18, 10, "2024/05/30 06:39:12"],
"5": [0, 0, 10, 18, 10, "2024/05/30 06:38:56"],
"6": [0, 0, 10, 18, 10, "2024/05/30 06:37:12"],
"7": [0, 0, 10, 18, 10, "2024/05/30 06:36:18"],
"8": [0, 0, 10, 18, 10, "2024/05/30 06:34:12"]
}
}
2.2.4 ThingSpeak Payload(Type=1)
2.2.4.1 AT+MOD=1(Real-Time Open/Close Status)
field1=work mod value&field2=count mode value&ield3=tdc send flag value&field4=trigger mode value&field5=alarm value&field6=pa8 level status value&field7=count time value&field8=door duration value
2.2.4.2 AT+MOD=2(3 pulse mode)
field1=work mod value&field2=calc flag value&field3=count mode value&ield4=tdc send flag value&field5=count time1 value&field6=count time2 value&field7=count time3 value&field8=Battery value
2.3 Uplink Payload
2.3.1 Real-Time Open/Close Status
Default working mode, AT+MOD=1:
The wiring of the Real-Time Open/Close Status mode is as follows:
2.3.2 pulse mode
To use this working mode, you need to set AT+MOD=2.
The wiring of the three pulse counting mode are as follows:
Related AT Command:
AT+TTRMOD1: Port1 count mode; 0: Signal falling edge(Default), 1: Signal raising edge
AT+TTRMOD1=0
AT+TTRMOD1=1
AT+TTRMOD2: Port2 count mode; 0: Signal falling edge(Default), 1: Signal raising edge
AT+TTRMOD2=0
AT+TTRMOD2=1
AT+TTRMOD3: Port3 count mode; 0: Signal falling edge(Default), 1: Signal raising edge
AT+TTRMOD3=0
AT+TTRMOD3=1
AT+CALCFLAG: Calculate Flag ( Default : 0 )
AT+CALCFLAG=aa
AT+COUNTMOD: Accumulative Mode; 0: Accumulative (Default),1: Reset after uplink.
AT+COUNTMOD=0
AT+COUNTMOD=1
AT+SETCNT: Set count value
AT+SETCNT=1,aa
AT+SETCNT=2,aa
AT+SETCNT=3,aa
2.4 Test Uplink and Change Update Interval
By default, Sensor will send uplinks every 2 hours
User can use below commands to change the uplink interval.
AT+TDC=7200 // Set Update Interval to 7200s
User can also push the button for more than 1 seconds to activate an uplink.
2.5 Multi-Samplings and One uplink
Notice: The AT+NOUD feature is upgraded to Clock Logging, please refer Clock Logging Feature
To save battery life, CPL03-NB will sample Water Flow data every 15 minutes and send one uplink every 2 hours. So each uplink it will include 8 stored data + 1 real-time data. They are defined by:
- AT+TR=900 // The unit is seconds, and the default is to record data once every 900 seconds (15 minutes, the minimum can be set to 180 seconds)
- AT+NOUD=8 // The device uploads 8 sets of recorded data by default. Up to 32 sets of record data can be uploaded.
The diagram below explains the relationship between TR, NOUD, and TDC more clearly:
2.6 Trggier an uplink by external interrupt
CPL03-NB has an external trigger interrupt function. Users can use the PB15 pin to trigger the upload of data packets.
AT command:
- AT+INTMOD // Set the trigger interrupt mode
- AT+INTMOD=0 // Disable Interrupt
- AT+INTMOD=1 // Trigger by rising and falling edge
- AT+INTMOD=2 // Trigger by falling edge
- AT+INTMOD=3 // Trigger by rising edge
2.7 Enable / Disable Alarm
Feature: Enable/Disable Alarm for open/close event. Default value 0.
AT Command:
Command Example | Function | Response |
AT+DISALARM=1 | End node will only send packets in TDC time. | OK |
AT+DISALARM=0 | End node will send packets in TDC time or status change for door sensor | OK |
2.8 Alarm Base on Timeout
It only takes effect when AT+MOD=1.
CPL03-NB 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
Keep Status = 1: Monitor Close to Open event
Keep Status = 0: Monitor Open to Close event
2. Keep Time: Timeout to send an Alarm
Range 0 ~ 65535(0xFFFF) seconds.
If keep time = 0, Disable Alarm Base on Timeout feature.
If keep time > 0, device will monitor the keep status event and send an alarm when status doesn’t change after timeout.
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. CPL03-NB will send an uplink packet, the Alarm bit (the second bit of 1st byte of payload) on this uplink packet is set to 1.
AT+TTRIG=0,0 --> Default Value, disable timeout Alarm.
2.9 TTRIG timeout status alarm
It only takes effect when AT+MOD=1.
It needs to be used with AT+TTRIG . When TTRIG times out and causes an alarm, and the status does not change subsequently, an alarm packet will be sent at the alarm interval.
AT Command:
Command Example | Function | Response |
---|---|---|
AT+TTRALARM=0 | disable continuous alarm | OK |
AT+TTRALARM=60 | The alarm interval is 60 minutes (unit: minutes) | OK |
2.10 Set trigger mode of PA8
Feature: Set the trigger interrupt mode.
AT Command: AT+TTRMOD1
Command Example | Function | Response |
---|---|---|
AT+TTRMOD1=1 | Count and trigger from open to close (rising edge) | OK |
AT+TTRMOD1=0 | Count and trigger from close to open (falling edge) | OK(default) |
2.11 Set trigger mode of PA4
It only takes effect when AT+MOD=2.
Feature: Set the trigger interrupt mode.
AT Command: AT+TTRMOD2
Command Example | Function | Response |
---|---|---|
AT+TTRMOD2=1 | Count and trigger from open to close (rising edge) | OK |
AT+TTRMOD2=0 | Count and trigger from close to open (falling edge) | OK(default) |
2.12 Set trigger mode of PB15
It only takes effect when AT+MOD=2.
Feature: Set the trigger interrupt mode.
AT Command: AT+TTRMOD3
Command Example | Function | Response |
---|---|---|
AT+TTRMOD3=1 | Count and trigger from open to close (rising edge) | OK |
AT+TTRMOD3=0 | Count and trigger from close to open (falling edge) | OK(default) |
2.13 Set the calculate flag
It only takes effect when AT+MOD=2.
Feature: Set the calculate flag.(Range is 0 to 7)
AT Command: AT+CALCFLAG
Command Example | Function | Response |
---|---|---|
AT+CALCFLAG =0 | Set the calculate flag to 0. | OK(default) |
AT+CALCFLAG =2 | Set the calculate flag to 2. | OK |
2.14 Set count number
Feature: Manually set the count number
In Real-Time Open/Close Status mode work mode, the Total_pulse set by the "AT+SETCNT=1,xx" command.
In 3 x pulse counting mode work mode, the Port1_Total_pulse(PA8) set by the "AT+SETCNT=1,xx" command.
AT Command: AT+SETCNT
Command Example | Function | Response |
---|---|---|
AT+ SETCNT =1,0 | Set the count number to 0. | OK |
AT+ SETCNT =2,100 | Set the count number to 100. | OK |
AT+ SETCNT =3,50 | Set the count number to 50. | OK |
2.15 Clear all counter values
Feature: Manually clear all counter values
AT Command:
Command Example | Function | Response |
---|---|---|
AT+CLRC | Clear current open count and the duration of the last open | OK |
AT Command: 0x10 00
This downlink command has been added since V1.2.3.
2.16 Count Mod
Feature: Manually set the count mode.
AT Command:
Command Example | Function | Response |
---|---|---|
AT+COUNTMOD=0 | the count value keeps accumulating mode | OK(default) |
AT+COUNTMOD=1 | the count value will be reset after each TDC time(Last Close Duration Reset after each uplink) | OK |
2.17 Work Mod
Feature: Manually set the work mode.
AT Command:
Command Example | Function | Response |
---|---|---|
AT+MOD=1 | Set the Real-Time Open/Close Status mode. | OK(default) |
AT+MOD=2 | Set the 3 x pulse counting mode. | OK |
2.18 Clock logging (Since firmware version v1.2.1)
Sometimes when we deploy lots of end nodes in field. We want all sensors sample data at the same time, and upload these data together for analyze. In such case, we can use clock loging feature.
We can use this command to set the start time of data recording and the time interval to meet the requirements of the specific collection time of data.
- AT Command: AT+CLOCKLOG=a,b,c,d
a: 0: Disable Clock logging. 1: Enable Clock Logging
b: Specify First sampling start second: range (0 ~ 3599, 65535) // Note: If parameter b is set to 65535, the log period starts after the node accesses the network and sends packets.
c: Specify the sampling interval: range (0 ~ 255 minutes)
d: How many entries should be uplink on every TDC (max 32)
Note: To disable clock recording, set the following parameters: AT+CLOCKLOG=1,65535,0,0
Example:
AT+CLOCKLOG=1,65535,1,5
After the node sends the first packet, data is recorded to the memory at intervals of 1 minute. For each TDC uplink, the uplink load will include: battery information + the last 5 memory records (payload + timestamp).
Note: Users need to synchronize the server time before configuring this command. If the server time is not synchronized before this command is configured, the command takes effect only after the node is reset.
- Downlink Command: 0x0A
Format: Command Code (0x0A) followed by 5 bytes.
- Example 1: Downlink Payload: 0A01FFFF0F08 // Set SHT record time: AT+CLOCKLOG=1,65535,15,8
- Example 1: Downlink Payload: 0A0104B00F08 // Set SHT record time: AT+CLOCKLOG=1,1200,15,8
Note: When entering the downlink payload, there must be no Spaces between bytes.
2.19 Example Query saved historical records
- AT Command: AT+CDP
This command can be used to search the saved history, recording up to 32 groups of data, each group of historical data contains a maximum of 100 bytes.
2.20 Uplink log query
- AT Command: AT+GETLOG
This command can be used to query upstream logs of data packets.
2.21 Scheduled domain name resolution
This command is used to set up scheduled domain name resolution.
AT command:
- AT+DNSTIMER=XX // Unit: hour
After setting this command, domain name resolution will be performed regularly.
2.22 Set the QoS level
This command is used to set the QoS level of MQTT.
AT command:
- AT+MQOS=xx // 0~2
Downlink Command: 0x07
Format: Command Code (0x07) followed by 1 byte.
Ex1: Downlink payload: 0x0700 //AT+MQOS=0
Ex2: Downlink payload: 0x0701 //AT+MQOS=1
2.23 Set the downlink debugging mode(Since firmware v1.3.0)
Feature: Set the conversion between the standard version and 1T version downlinks.
AT command: AT+DOWNTE
Command Example | Function/Parameters | Response/Explanation |
---|---|---|
AT+DOWNTE=? | Get current Settings | 0,0 (default) OK |
AT+DOWNTE=a,b | a: Set the conversion between the downlink of the standard version and 1T version | 0: Set the downlink of the standard version. |
b: Enable/Disable downlink debugging | 0: Disable downlink debugging mode. |
Example:
- AT+DOWNTE=0,1 //Set to standard version downlink, and enable downlink debugging.
- AT+DOWNTE=1,1 //Set to 1T version downlink, and enable downlink debugging.
Downlink Command:
No downlink commands for feature
2.24 Domain name resolution settings(Since firmware v1.3.0)
Feature: Set dynamic domain name resolution IP.
AT command: AT+BKDNS
Command Example | Function/Parameters | Response/Explanation |
---|---|---|
AT+BKDNS=? | Get current Settings | 0,0,NULL (default) OK |
AT+BKDNS=a,b,c |
a: Enable/Disable dynamic domain name resolution. | 1: Disable dynamic domain name update. The ip address will be saved after the domain name is resolved, if the next domain name resolution fails, the last saved ip address will be used. 2: Enable dynamic domain name update. The ip address will be saved after domain name resolution, if the next domain name resolution fails, the last saved ip address will be used, and the domain name resolution will be updated regularly according to the time set by the customer. |
b: Set the time to update the domain name resolution at regular intervals. |
Unit: hour | |
c: Set the IP address manually. | The format is the same as AT+SERVADDR. If domain name resolution fails, this ip address will be used directly, if domain name resolution succeeds, parameter c will be updated to the successfully resolved IP address. |
Example:
- AT+BKDNS=1,0 //Dynamic domain name resolution is disabled.
- AT+BKDNS=2,1 //The dynamic domain name resolution function is enabled and the automatic update time is set to 1 hour.
- AT+BKDNS=2,4,3.69.98.183,1883 //The dynamic domain name resolution function is enabled and the automatic update time is set to 4 hour, and manually set the ip address, if the domain name failed to resolve, it will directly use this ip to communicate. When the next domain name resolution is successful, it will be updated to the ip address of the successful resolution.
Downlink Command:
No downlink commands for feature
3. Configure CPL03-NB
3.1 Configure Methods
CPL03-NB supports below configure method:
- AT Command via Bluetooth Connection (Recommended): BLE Configure Instruction.
- AT Command via UART Connection : See UART Connection.
3.2 Serial Access Password
After the Bluetooth or UART connection is successful, use the Serial Access Password to enter the AT command window.
The label on the box of the node will print the initial password: AT+PIN=xxxxxx, and directly use the six-digit password to access the AT instruction window.
If you need to change the password, use AT+PWORD=xxxxxx (6 characters), NB nodes only support lowercase letters.
Note: After entering the command, you need to add a line break, and you can also set automatic line breaks in the Bluetooth tool or UART connection tool.
3.3 AT Commands Set
AT+<CMD>? : Help on <CMD>
AT+<CMD> : Run <CMD>
AT+<CMD>=<value> : Set the value
AT+<CMD>=? : Get the value
General Commands
AT : Attention
AT? : Short Help
ATZ : MCU Reset
AT+TDC : Application Data Transmission Interval
AT+CFG : Print all configurations
AT+DEUI : Get or set the Device ID
AT+5VT : Set extend the time of 5V power
AT+PRO : Choose agreement
AT+RXDL : Extend the sending and receiving time
AT+DNSCFG : Get or Set DNS Server
AT+GETSENSORVALUE : Returns the current sensor measurement
AT+NOUD : Get or Set the number of data to be uploaded
AT+CDP : Read or Clear cached data
AT+SERVADDR : Server Address
MQTT Management
AT+CLIENT : Get or Set MQTT client
AT+UNAME : Get or Set MQTT Username
AT+PWD : Get or Set MQTT password
AT+PUBTOPIC : Get or Set MQTT publish topic
AT+SUBTOPIC : Get or Set MQTT subscription topic
Information
AT+FDR : Factory Data Reset
AT+PWORD : Serial Access Password
AT+LDATA : Get the last upload data
AT+CDP : Read or Clear cached data
4. Battery & Power Consumption
CPL03-NB use ER26500 + SPC1520 battery pack. See below link for detail information about the battery info and how to replace.
Battery Info & Power Consumption Analyze .
5. Firmware update
User can change device firmware to::
- Update with new features.
- Fix bugs.
Firmware and changelog can be downloaded from : Firmware download link
Methods to Update Firmware:
- (Recommended way) OTA firmware update via BLE: Instruction.
- Update through UART TTL interface : Instruction.
6. FAQ
6.1 How can I access t BC660K-GL AT Commands?
User can access to BC660K-GL directly and send AT Commands.
6.2 How to Connect Dry contacts or Wet Contacts
CPL03-NB can only be connected to dry contacts by default, and the wiring method is to connect the two ports of dry contacts to the VDD pin and pulse input pin of CPL03-NB respectively.
If you want to connect a wet contact, you need to change the original wiring method. The wiring method is that the GND of the wet contact is connected to the GND of CPL03-NB, and the pulse output is connected to the pulse pin, but the pulse output voltage of the wet contact must be less than 3.6V.
6.3 What is the maximum total number of pulses for CPL03? What happens after the maximum total number of pulses is reached?
The maximum total number of pulses for CPL03 is three bytes FF FF FF (16,777,215).
The count is reset when the maximum total number of pulses is reached.
6.4 How to configure the certificate?
User can can refer to this description to configure the certificate.
7. Order Info
Part Number: CPL03-NB-XX
XX:
- GE: General version ( Exclude SIM card)
- 1T: with 1NCE * 10 years 500MB SIM card and Pre-configure to ThingsEye server
8. Packing Info
Package Includes:
- CPL03-NB NB-IoT Pulse/Contact sensor x 1
- External antenna x 1
Dimension and weight:
- Device Size: 13.0 x 5 x 4.5 cm
- Device Weight: 150g
- Package Size / pcs : 14.0 x 8x 5 cm
- Weight / pcs : 180g
9. Support
- Support is provided Monday to Friday, from 09:00 to 18:00 GMT+8. Due to different timezones we cannot offer live support. However, your questions will be answered as soon as possible in the before-mentioned schedule.
- Provide as much information as possible regarding your enquiry (product models, accurately describe your problem and steps to replicate it etc) and send a mail to Support@dragino.cc.