User Guide for Milesight models including: WS203 Motion Temperature and Humidity Sensor, WS203, Motion Temperature and Humidity Sensor, Temperature and Humidity Sensor, Humidity Sensor, Sensor
Milesight WS203 - Airteq
File Info : application/pdf, 26 Pages, 2.38MB
DocumentDocumentMotion & TH Sensor Featuring LoRaWAN® WS203 User Guide Safety Precautions Milesight will not shoulder responsibility for any loss or damage resulting from not following the instructions of this operating guide. The device must not be disassembled or remodeled in any way. Do not expose the PIR lens to direct sunlight. Do not paint or clean the PIR lens, or it will affect the detection of the device. Ensure that you install the battery properly. Choose the right model and make it connect to the positive and negative terminals rightly. Do not place the device where the temperature is below/above the operating range. Do not place the device close to objects with naked flames, heat source (such as oven), or exposure to sunlight, cold source, liquid, and extreme temperature changes. Remove the battery from the device if it is not to be used for an extended period. Otherwise, the battery might leak and damage the device. The device must never be subjected to shocks or impacts. Declaration of Conformity WS203 is in conformity with the essential requirements and other relevant provisions of the CE, FCC, and RoHS. Copyright © 2011-2023 Milesight. All rights reserved. All information in this guide is protected by copyright law. Whereby, no organization or individual shall copy or reproduce the whole or part of this user guide by any means without written authorization from Xiamen Milesight IoT Co., Ltd. For assistance, please contact Milesight technical support: Email: iot.support@milesight.com Support Portal: support.milesight-iot.com Tel: 86-592-5085280 Fax: 86-592-5023065 Address: Building C09, Software Park Phase III, Xiamen 361024, China 2 Revision History Date Aug. 3, 2023 Doc Version Description V 1.0 Initial version 3 Contents 1. Product Introduction ......................................................................................................................... 5 1.1 Overview ...................................................................................................................................5 1.2 Key Features ............................................................................................................................ 5 2. Hardware Introduction ...................................................................................................................... 5 2.1 Packing List ..............................................................................................................................5 2.2 Hardware Overview ................................................................................................................. 6 2.3 Power Button and LED Indicator ............................................................................................ 6 2.4 Dimensions (mm) .................................................................................................................... 7 3. Operation Guide .................................................................................................................................7 3.1 NFC Configuration ................................................................................................................... 7 3.2 LoRaWAN® Settings ................................................................................................................ 8 3.3 General Settings .................................................................................................................... 10 3.4 Advanced Settings ................................................................................................................ 11 3.4.1 Calibration Settings .................................................................................................... 11 3.4.2 Threshold Settings ..................................................................................................... 11 3.4.3 Data Storage ............................................................................................................... 12 3.4.4 Data Retransmission .................................................................................................. 13 3.4.5 Milesight D2D Settings ...............................................................................................14 3.5 Maintenance .......................................................................................................................... 15 3.5.1 Backup .........................................................................................................................15 3.5.2 Upgrade ....................................................................................................................... 16 3.5.3 Reset to Factory Default .............................................................................................16 4. Installation ....................................................................................................................................... 17 5. Device Payload ................................................................................................................................ 19 5.1 Basic Information .................................................................................................................. 19 5.2 Sensor Data ........................................................................................................................... 20 5.3 Downlink Commands ............................................................................................................ 21 5.4 Historical Data Enquiry ..........................................................................................................23 4 1. Product Introduction 1.1 Overview WS203 is an environmental monitoring device that combines motion and temperature/humidity (TH) sensors. By detecting motion within a 6-meter range based on passive infrared (PIR) technology, the WS203 can trigger TH detection and periodically report environmental status over the LoRaWAN® network. With easy configuration and wireless detection, the WS203 offers a reliable and convenient solution for space and TH optimization. Compatible with the Milesight LoRaWAN® gateway and Milesight IoT Cloud platform, it enables real-time monitoring of occupant status for effective remote management. The WS203 can find applications in various settings including smart offices, buildings, hospitals, and more. 1.2 Key Features Equipped with passive infrared and Fresnel Lens for motion or occupancy detection Built-in high-accurate TH sensor along with PIR sensor enabling communicative triggers Provide different types of PIR covers for adjustable and flexible field angles and different detecting ranges Store locally 1000 historical records and support retransmission to prevent data loss Equipped with NFC for one-touch configuration and support card emulation mode Function well with standard LoRaWAN® gateways and network servers Compatible with Milesight IoT Cloud Support Milesight D2D protocol to enable ultra-low latency and direct control without a gateway 2. Hardware Introduction 2.1 Packing List 1 × WS203 Sensor 4 × PIR Covers 1 × 3M Tape 2 × Mounting Kits 5 1 × Quick Start Guide 1× Warranty Card If any of the above items are missing or damaged, please contact your sales representative. 2.2 Hardware Overview 2.3 Power Button and LED Indicator Function Power On/Off Action Press and hold the power button for more than 3 seconds Check On/Off Status Quickly press the power button once. Reset to Factory Default PIR Status Press and hold the power button for more than 10 seconds Vacant Occupied Occupied Vacant LED Indicator Power On: Off On Power Off: On Off Light On: Device is on Light Off: Device is off Blink quickly Blinks twice Blinks twice 6 2.4 Dimensions (mm) 3. Operation Guide 3.1 NFC Configuration WS203 sensor can be monitored and configured via NFC. Please refer to the following configuration steps. 1. Download and install the Milesight ToolBox App from Google Play or Apple App Store. 2. Enable NFC on the smartphone and launch Milesight ToolBox. 3. Attach the NFC area of a smartphone to the device, and click NFC Read to read device information. The basic information and settings of the device will be shown on ToolBox App if it's recognized successfully. You can read and configure the device by tapping the Read/Write device on the App. In order to protect the security of the device, please change the password when first configuring. The default password is 123456. Note: 1) Ensure the location of NFC area of the smartphone and it's recommended to take off phone case. 2) If the smartphone fails to read/write configurations via NFC, remove the phone and try again. 3) WS203 sensor can also be configured by a dedicated NFC reader provided by Milesight IoT. 7 3.2 LoRaWAN® Settings Go to Device > Settings > LoRaWAN® Settings of ToolBox App to configure AppEUI, Join Type, Application Key, and other information. You can also keep all settings by default. Parameters Device EUI App EUI Application Port Join Type Application Key Network Session Key Application Session Key Device Address LoRaWAN® Version Work Mode RX2 Data Rate RX2 Frequency Description Unique ID of the device which can also be found on the label. The default App EUI is 24E124C0002A0001. The port is used for sending and receiving data, the default port is 85. OTAA and ABP modes are available. Appkey for OTAA mode, the default is 5572404C696E6B4C6F52613230313823. Nwkskey for ABP mode, the default is 5572404C696E6B4C6F52613230313823. Appskey for ABP mode, the default is 5572404C696E6B4C6F52613230313823. DevAddr for ABP mode, the default is the 5th to 12th digits of the SN. V1.0.2 and V1.0.3 are available. It's fixed as Class A. RX2 data rate to receive downlinks. RX2 frequency to receive downlinks. Unit: Hz 8 Channel Mode Select Standard-Channel mode or Single-Channel mode. When Single-Channel mode is enabled, only one channel can be selected to send uplinks. Please enable Single-Channel mode if connecting to the DS7610. Enable or disable the frequency to send uplinks. Examples: 1, 40: Enabling Channel 1 and Channel 40 1-40: Enabling Channel 1 to Channel 40 1-40, 60: Enabling Channel 1 to Channel 40 and Channel 60 All: Enabling all channels Null: Indicate that all channels are disabled Channel If the device does not receive an ACK packet from the network server, it will Confirmed Mode resend data once. Reporting interval 35 mins: the device will send a specific number of LinkCheckReq MAC packets to the network server every reporting interval or every double reporting interval to validate connectivity; If there is no response, Rejoin Mode the device will re-join the network. Reporting interval > 35 mins: the device will send a specific number of LinkCheckReq MAC packets to the network server every reporting interval to validate connectivity; If there is no response, the device will re-join the network. Set the number of When the rejoin mode is enabled, set the number of LinkCheckReq packets to 9 packets sent send. Note: the actual sending number is Set the number of packet sent + 1. ADR Mode Allow network server to adjust data rate of the device. Spread Factor If ADR is disabled, the device will send data via this spread factor. Tx Power Transmit power of the device. Note: 1) Please contact sales for device EUI list if there are many units. 2) Please contact sales if you need random App keys before purchase. 3) Select OTAA mode if you use Milesight IoT cloud to manage devices. 4) Only OTAA mode supports rejoin mode. 3.3 General Settings Go to Device > Setting > General Settings of ToolBox App to set the reporting interval, etc. Parameters Description Temperature Unit Set the unit of temperature displayed on the status page. The interval of reporting PIR status, temperature, humidity, and battery level to network server. Default: 30 min, Range: 1 - 1440 min Reporting Interval Note: WS203 will report PIR "Occupied" status trigger packet immediately when it detects motions and the reporting interval will be re-calculated. Time to Report Vacancy / min A "Vacant" status trigger packet will be reported if the device does not detect motion within a certain period of time and the reporting interval will be re-calculated. Default: 5 min, Range: 1 60 min 10 LED Indicator Data Storage Enable or disable the LED to indicate PIR status. Disable or enable data storage locally. (see section 3.4.3 ) Data Retransmission Disable or enable data retransmission. (see section 3.4.4) Change Password Change the password for ToolBox App to write this device. 3.4 Advanced Settings 3.4.1 Calibration Settings WS203 supports numerical calibration of the temperature and humidity value. Go to Device > Settings > Calibration Settings of ToolBox App to set the calibration value, the device will add calibration value to the current value and upload the final value. 3.4.2 Threshold Settings Go to Device > Settings > Threshold Settings of ToolBox App to enable the threshold settings and input the temperature threshold. If the temperature threshold is triggered, the device will upload the alarm packet once instantly and collect the temperature & humidity data as collect interval until the alarm releases. 11 3.4.3 Data Storage WS203 supports storing 1000 data records locally and exports data via ToolBox App. The device will record the data according to the reporting interval even not joining the network. 1. Go to Device > Status of ToolBox App to sync the device time. 2. Go to Device > Setting > General Settings to enable the data storage feature. 3. Go to Device > Maintenance of ToolBox App, click Export, then select the data time range and click Confirm to export data. The maximum export data period on ToolBox App is 14 days. 4. Click Export Record to find the export file records. Note: Slide the file record to the left to delete the record. 5. Click Data Cleaning to clear all stored data inside the device if necessary. 12 3.4.4 Data Retransmission WS203 supports data retransmission to ensure the network server can get all data even if the network is down for some time. There are two ways to get the lost data: Network server sends downlink commands to enquire the historical data for specifying time range, refer to section 5.4; When network is down and no response from LinkCheckReq MAC packets for a period of time, the device will record the time of disconnection form the network and retransmit the lost data after the device is reconnected to the network. Here are the steps of data retransmission: 1. Go to Device > Setting > General Settings to enable data storage feature and data retransmission feature. 2. Go to Device > Setting > LoRaWAN Settings to enable rejoin mode feature and set the number of packets sent. Take below as example, the device will send LinkCheckReq MAC packets to the network server regularly to check if the network is disconnected; if there is no response for 8+1 times, the join status will change to de-active and the device will record a data lost time point (the time to join the network). 3. After the network connected back, the device will send the lost data from the point in time when the data was lost according to the data re-transmission reporting interval. Note: 1) If the device is rebooted or re-powered when data retransmission is not completed, the device will re-send interrupted retransmission data again after the device is reconnected back to the network. 2) If the network is disconnected again during data retransmission, the device will only send the latest disconnection data. 3) The retransmission data format is started with "20ce", please refer to section 5.4. 4) Data retransmission will increase the uplinks and shorten the battery life. 13 3.4.5 Milesight D2D Settings Milesight D2D protocol is developed by Milesight and used for setting up transmission among Milesight devices without a gateway. When the Milesight D2D setting is enabled, WS203 can work as a Milesight D2D controller to send control commands to trigger Milesight D2D agent devices. 1. Configure RX2 data rate and RX2 frequency in LoRaWAN® settings, it is suggested to change the default value if there are many LoRaWAN® devices around. 2. Go to Device > Settings > D2D Settings to enable D2D function and configure the D2D settings. Parameters Enable D2D Key Status Condition Description Enable or disable Milesight D2D feature. Define a unique D2D key which is the same as the setting in D2D agent devices. Default value: 5572404C696E6B4C6F52613230313823 When WS203 detects one or more of the below statuses, it will send the control command to the corresponding Milesight D2D agent devices: Occupied & Temperature threshold triggered Occupied (PIR) Vacant (PIR) Temperature threshold triggered Temperature threshold is lifted Note: for temperature threshold conditions, please enable and configure 14 the temperature threshold feature under Threshold Settings. Control command Define a 2-byte hexadecimal control command (0x0000 to 0xffff). If enabled, a LoRaWAN® uplink packet that contains the PIR status or LoRa Uplink temperature alarm will be sent to gateway after the Milesight D2D control command is sent. Control Time /min1 After receiving commands from WS203, Milesight D2D agent devices will take corresponding actions for this duration. Default: 5 mins, Range: 1 - 1440 mins 3.5 Maintenance 3.5.1 Backup WS203 supports backup templates for easy and quick configuring devices in bulk. The backup feature is only for devices with the same model and LoRaWAN® frequency band. 1. Go to Template page on the App and save the current settings as a template. The saved templates are also editable. 2. Select one saved template and click Write, then attach the smartphone to another device via NFC to reuse the template. Note: Slide the template item to the left to edit or delete the template. Click the template to edit the configurations. 1 This feature is under development on Milesight D2D agent devices. 15 3.5.2 Upgrade 1. Download firmware from the Milesight website to your smartphone. 2. Go to Device > Maintenance of ToolBox App, tap Browse to import firmware and upgrade the device. Note: 1) Operation on ToolBox is not supported during the upgrade. 2) Only the Android version of ToolBox supports the upgrade feature. 3.5.3 Reset to Factory Default WS203 supports two methods to reset the device which are as following: Via Hardware: Press and hold the power button for more than 10s until the LED indicator blinks quickly. Via ToolBox App: Go to Device > Maintenance to tap Reset, then attach the smartphone to the device via NFC to complete the reset. 16 4. Installation Installation Note: 1. Adjust the installation direction according to the detection area requirement. 2. Ensure the detection area does not have moving objects like waving trees and fans. 3. Ensure the detection area is not blocked by curtains or barriers. 4. Do not expose the device to direct infrared (including sunlight, light, etc.), or the PIR detection will be affected. 5. The recommended installation location is 2 m in height on the wall with the half PIR cover to avoid room light inference. 6. Avoid the device to face a transparent plate (like glass) within 5m since the PIR will detect through it. PIR Cover Installation: Take off the front cover of the device, then select the PIR cover as required and put it on the PIR sensor with groove alignment. The adjustable angle of every groove is 30°. 17 PIR cover reference guidance(wall mount and installation height=2m): PIR Cover Detection Area Maximum: 120 ° Horizontal, 50 ° Vertical, 6 m Recommend: 98 ° Horizontal, 44.4° Vertical, 5 m Maximum: 38 ° Horizontal, 50 ° Vertical, 6 m Recommend: 38 ° Horizontal, 44.4° Vertical, 5 m Maximum: 38 ° Horizontal, 100 ° Vertical, 6 m Recommend: 38 ° Horizontal, 88.8° Vertical, 5 m Maximum: 120 ° Horizontal, 100 ° Vertical, 6 m Recommend: 98 ° Horizontal, 88.8° Vertical, 5 m Support to be tailored as required Fixed by 3M Tape: Attach 3M tape to the back of the sensor, then tear the other side and place it on a flat surface. Please adjust the installation direction according to the detection area. Note: 1. Since the default 3M tape has a high viscosity, please tear the device down via a screwdriver. 2. If it is necessary to tear the device down easily, please divide the 3M tape into several parts and only tear one part to the device. 18 Fixed by Mounting Kits: 1. Take off the front cover of the device, then fix the wall plugs to a flat surface according to the device mounting holes. Finally, secure the device to the wall plugs using screws. Please adjust the installation direction according to the detection area. 2. Restore the front cover back to the device. 5. Device Payload All the data is based on the following format (HEX), the Data field should follow the little-endian: Channel1 Type1 Data1 Channel2 Type2 Data2 Channel 3 ... 1 Byte 1 Byte N Bytes 1 Byte 1 Byte M Bytes 1 Byte ... For decoder examples please find the files on https://github.com/Milesight-IoT/SensorDecoders. 5.1 Basic Information WS203 sensor reports basic information whenever joining the network. Channel Type Description 0b (Power On) Device is on 01(Protocol Version) 01=>V1 ff 16 (Device SN) 16 digits 09 (Hardware Version) 01 40 => V1.4 0a (Software Version) 01 14 => V1.14 19 0f (Device Type) 00: Class A, 01: Class B, 02: Class C Example: ff0bff ff0101 ff166791d19604050005 ff090100 ff0a0101 ff0f00 Channel ff Channel ff Channel ff Type 0b (Power On) Type 16 (Device SN) Type 0a (Software Version) Value ff (Reserved) Value 6791d19604050 005 Value 0101 (V1.1) Channel ff Channel ff Channel Type 01 (Protocol Version) Type 09 (Hardware Version) Type Value 01 (V1) Value 0100 (V1.0) Value 0f 00 ff (Device Type) (Class A) 5.2 Sensor Data Item Battery Level Temperature Humidity PIR Status Temperature Alarm Channel 01 03 04 05 83 Type 75 67 68 00 67 Description UINT8, Unit: % INT16, Unit: °C, Resolution: 0.1 °C UINT8, Unit: %, Resolution: 0.5 %RH 00: Vacant; 01: Occupied Temperature (2 Bytes) + Alarm Status(1 Byte) Temperature: unit -- °C Alarm Status: 00 -Alarm release 01 -Alarm Examples: 1. Periodic packet: report as reporting interval (30 minutes by default). 017562 0367d500 04687f 050001 Channel Type Value Channel Type 75 01 62=>98% (Battery Level) 67 03 (Temperature) Channel 04 Type 68 (Humidity) Value 7f=>127 Hum=127* Channel 05 Type 00 (PIR Status) Value d5 00=>00 d5=213 Temp=213*0.1 =21.3°C Value 01=>Occupied 20 0.5=63.5% 2. PIR trigger packet: report when PIR status changes. 0367d500 04687f 050001 Channel 03 Channel 05 Type 67 (Temperature) Type 00 (PIR Status) Value d5 00=>00 d5=213 Temp=213*0.1= 21.3°C Value Channel 04 Type 68 (Humidity) Value 7f=>127 Hum=127*0.5= 63.5% 01=>Occupied 3. Temperature alarm packet: report when the temperature reaches the threshold or returns back to normal value. 83670e0101 04687a Channel 83 Type 67 (Temperature) Value Temperature: 0e 01 =>01 0e = 270 * 0.1 = 27 °C 01= Alarm Channel 04 Type 68 (Humidity) Value 7a=>122 Hum=122*0.5= 61% 5.3 Downlink Commands WS203 supports downlink commands to configure the device. The application port is 85 by default. Channel Type Description 10 (Reboot) ff 2f (LED Indicator) 00: disable; 01: enable 3 Bytes, 8e (Reporting Interval) Byte 1: 00 ff 95 (Time to report vacancy) Byte 2-3: interval time, unit: min 2 Bytes, unit: s 68 (Data Storage) 00: disable, 01: enable 69 (Data Retransmission) 00: disable, 01: enable 3 Bytes 6a (Data Retransmission Interval) Byte 1: 00 Byte 2-3: interval time, unit: s 21 84 (D2D Feature) 96 (D2D Settings) 06 (Threshold Alarm) Example: 1. Reboot the device. Channel ff Type 10 (Reboot) 2. Set reporting interval as 2 minutes. range: 30~1200s (600s by default) 1 Byte, 00: disable; 01: enable 8 Bytes, Byte 1: 00-All threshold conditions; 01-Occupancy&Temperature threshold triggered; 02-Occupied; 03-Vacant; 04-Temperature threshold triggered; 05-Temperature threshold is lifted Byte 2: 00-disable, 01-enable Byte 3: 00-disable LoRa Uplink, 01-enable LoRa Uplink Byte 4-5: D2D control command Byte 6-7: control time, unit: min Byte 8: 00-disable control time, 01-enable control time 9 Bytes, CTRL(1B)+Min(2B)+Max(2B)+ 00000000(4B) CTRL: Bit0~Bit2: 000-disable 001-below (minimum threshold) 010-above (maximum threshold) 011-within 100-below or above Bit3~Bit7: 11001 ff10ff Value ff (Reserved) 22 Channel ff ff8e 00 0200 Type 8e (Reporting Interval) Value 02 00=>00 02=>2 mins 3. Set time to report vacancy as 2 minutes. ff957800 Channel Type ff 95 (Time to report vacancy) Value 78 00=>00 78=>120 s=2 mins 4. Set LED indicator. Channel ff Type 2f (LED Indicator) ff2f01 Value 01=>Enable 5. Enable D2D feature. Channel ff ff8401 Type 84 (D2D Feature) Value 01=Enable 6. Set D2D settings. ff96 01 01 01 04e0 0500 01 Channel Type ff 96 (D2D Settings) Value 01=>Occupied&Temperature threshold triggered; 01=>Enable; 01=>Enable LoRa Uplink; 04 e0=>e0 04, Control Command is e0 04; 05 00=>00 05, Control time is 5 mins; 01=>Enable Control Time 7. Set threshold alarm. ff06 cc 9600 2c01 00000000 Channel Type Value Ctrl: cc=>11001100 ff 06 (Threshold Alarm) 100=below or above Min_value: 96 00=>00 96=15°C Max_value: 2c 01=>01 2c=30°C 5.4 Historical Data Enquiry WS203 supports sending downlink commands to enquire historical data for specified time point or time range. Before that, ensure the device time is correct and the data storage feature was 23 enabled to store the data. Command format: Channel Type Description fd 6b (Enquire data in time point) 4 Bytes, Unix timestamp Start time (4 bytes) + End time (4 bytes), fd 6c (Enquire data in time range) Unix timestamp fd 6d (Stop query data report) ff 3 Bytes, ff 6a (Report Interval) Byte 1: 01 Byte 2: interval time, unit: s, range: 30~1200s (60s by default) Reply format: Channel Type Description 1 Byte, fc 6b/6c 00: data enquiry success 01: time point or time range invalid 02: no data in this time or time range 9 Bytes, Data time stamp (4 Bytes) + Trigger Status (1 Byte) + PIR Status (1 Byte) + Temperature (2 Bytes) + Humidity (1 Byte) 20 ce (Historical Data) Trigger_status: 00 - temperature threshold alarm is released 01 - temperature threshold alarm triggered 02 - PIR vacant trigger 03 - PIR occupied trigger 04 - periodic report Note: 1. The device only uploads no more than 300 data records per range enquiry. 2. When enquiring the data in time point, it will upload the data which is the closest to the search point within the reporting interval range. For example, if the device's reporting interval is 10 minutes and users send a command to search for 17:00's data, if the device finds there is data stored in 17:00, it will upload these data. If not, it will search for data between 16:50 to 17:10 and upload the data which is the closest to 17:00. 24 Example: 1. Enquire historical data between 2023/8/4 17:00:00 to 2023/8/4 17:15:00. fd6c10becc6494c1cc64 Channel Type 6c (Enquire data in time fd range) Value Start time: 10becc64=> 64ccbe10 = 1691139600s = 2023-08-04 17:00:00 End time: 94c1cc64 => 64ccc194 = 1691140500s = 2023-08-04 17:15:00 Reply: fc6c00 Channel fc Type 6c (Enquire data in time range) Value 00: data enquiry success Channel 20 Type ce (Historical Data) 20ce 7ac1cc64 04 01 0e01 7b Time Stamp 7ac1cc64 => 64ccc17a => 1691140474s = 2023-08-04 17:14:34 Value 04=>Periodic report PIR: 01=>Occupied; Temperature: 0e01=>010e = 27°C Humidity: 7b => 123 = 61.5% -END- 25 Service & Advies Heeft u vragen of opmerkingen over een sensor? Of zoekt u ondersteuning bij het instellen van de sensor? Onze medewerkers van de afdeling Service staan elke werkdag voor u klaar. U kunt contact opnemen door te bellen of te mailen. Telefoon: 0345 785 611 E-mail: support@AirTeq.eu www.AirTeq.eu Pascalweg 2a 4104 BG Culemborg Netherlands