Polysense WXS8000 User Manual
Rev 2.3
,
Mar 26
, 2018
User Guide
Revision 0.1
Polysense WxS8000 User Guide
Mar 26, 2018
Document Number: UG-XXXX
Revision 2.3
XXX-XXXX
Polysense WxS8000 User Guide
Polysense, Inc. Confidential
Page 1
Rev 2.3
,
Mar 26
, 2018
User Guide
Revision 0.1
XXX-XXXX
Polysense WxS8000 User Guide
Table of Contents
1. OVERVIEW ............................................................................................................................................................... 5
2. WXS8000 INTRODUCTION ...................................................................................................................................... 6
2.1. ANTENNA ................................................................................................................................................................ 7
2.2. POWER SOURCE ........................................................................................................................................................ 7
3. QUICK START ........................................................................................................................................................... 8
4. WXS8000 INTERFACE WITH LORA SERVER ........................................................................................................... 10
4.1. DOWNLINK MESSAGE .............................................................................................................................................. 10
4.1.1. SET INDIVIDUAL ATTRIBUTE IN PPB (PLSSSETPPB) .................................................................................................... 11
4.1.1.1. GENERAL ATTRIBUTES ....................................................................................................................................... 11
4.1.1.2. SENSOR SPECIFIC ATTRIBUTES ............................................................................................................................ 14
4.1.2. SET INDIVIDUAL ATTRIBUTE IN PRB (PLSSSETPRB) .................................................................................................... 18
4.1.3. SET MOTE LOCAL DATE-TIME (PLSSSETCLK) ............................................................................................................. 18
4.1.4. SET COUNTER SENSOR (PLSSSETEXTCNTR) ............................................................................................................... 19
4.1.5. GET INDIVIDUAL ATTRIBUTE IN PPB (PLSSGETPPB) ................................................................................................... 19
4.2. UPLINK MESSAGE ................................................................................................................................................... 19
4.2.1. SENSOR DATA REPORT WITH FIXED DATA LENGTH ..................................................................................................... 20
4.2.2. SENSOR DATA REPORT WITH VARIABLE DATA LENGTH ................................................................................................ 23
4.2.3. MOTE INFORMATION REPORT ................................................................................................................................ 25
4.2.4. MOTE LOCAL DATE-TIME REPORT ........................................................................................................................... 26
4.2.5. MOTE STATISTICS REPORT ..................................................................................................................................... 26
4.2.6. PPB ATTRIBUTE REPORT ....................................................................................................................................... 26
5. FIRMWARE UPGRADE ........................................................................................................................................... 28
5.1. FIRMWARE UPGRADE VIA ST-LINK ............................................................................................................................. 28
5.1.1. SETUP ST-LINK AND ST-LINK UTILITY .................................................................................................................... 28
5.1.2. FIRMWARE UPGRADE ........................................................................................................................................... 31
5.1.2.1. UPGRADE OLD WXS8000 FIRMWARE – SINGLE IMAGE .......................................................................................... 31
5.1.2.2. UPGRADE NEW WXS8000 FIRMWARE – LOADER + APPLICATION IMAGES ................................................................. 32
5.2. FIRMWARE UPGRADE VIA OTA .................................................................................................................................. 33
5.2.1. PREPARE FW IMAGE ...................................................................................................................................... 33
5.2.2. UPGRADE FW ................................................................................................................................................ 33
6. COMPLIANCES ....................................................................................................................................................... 35
CONTACT INFORMATION ................................................................................................................................................ 36
Polysense, Inc. Confidential
Page 2
Rev 2.3
,
Mar 26
, 2018
1.3 11/22/2017
. Added Chapter 5
1.4 12/14/2017
. Added ext
ernal ultrasonic sensor type (0xA) and
1.5 12/28/2017
. Added new
external
CO2 sensor support for
1.6 0
1/09/2018
. Added new external
current
sensor
and external
1.7 01/15/2018
. Added direction connection mappings between S
T
-
1.8 01/18/2018
. Supported proximity sensor
1.9 01/24/2018
. Added the channel planning settings on gateway
2.0 02/09/2018
. Added firmware upgrade via OTA
User Guide
Revision 0.1
Revision History
Revision Date History
1.0 10/26/2017 First revision
1.1 11/09/2017 Added Chapter 4
1.2 11/15/2017 . Corrected the wrong FPort in downlink frame,
XXX-XXXX
Polysense WxS8000 User Guide
should be 251 instead of 254
. Corrected the wrong attribute# in 4.1.1.2
CO2 (0x29) sensor type
. Added Distance and CO2 concentration in % data
types
. Added more regions
environment air CO2 quality monitoring as well as
new CO2 concentration in ppm data type
. Supported AS923 region
. Supported Carrier sensing mechanism and
configuration in PPB
. Supported cross-threshold data report according to
the pre-configured 2 thresholds in PPB
. Supported new PlssGetPPB message (refer to
section 4.1.5), and PPB attribute report message
(refer to section 4.2.4)
. Updated the endian rule in both uplink and
downlink message (refer to section 4.1 and 4.2)
. The downlink message type can be confirmed or
unconfirmed (refer to section 4.1)
pressure sensor as well as new data types in data
report
. Support periodic data report in parallel with crossthreshold data report
Link JTAG pins and WxS8000 JTAG pins in section 5.1
. Added ST-Link settings
. Added an example for proximity sensor settings
(refer to chapter 3)
. Updated sensor DATA_THRESHOLD1 comment
Polysense, Inc. Confidential
Page 3
Rev 2.3
,
Mar 26
, 2018
2.1 03/06/201
8 . Added Air quality/PM monitor sensor
2.2 03/21/2018
. Added section 4.2.2 Sensor Data Report with
User Guide
Revision 0.1
2.3 03/26/2018 . Added Compliances chapter
XXX-XXXX
Polysense WxS8000 User Guide
Variable Data Length
Polysense, Inc. Confidential
Page 4
Rev 2.3
,
Mar 26
, 2018
User Guide
Revision 0.1
1. Overview
Polysense WxS8000 is a powerful product portfolio which can support a very wide range of IoT
sensing applications, including but not limited to, smart/safe building, smart/safe city, perimeter
security, fire and gas monitoring, precision agriculture, object tracking, machine condition
monitoring, smart metering, utility pole tilt monitoring.
WxS8000 supports the LPWAN/LoRa as the uplink interface to transmit the sensor data to the
application server via the LoRa network.
WxS8000 supports below key functions:
1. Support outdoor deployment with IP64+ enclosure IP rating
2. Support 1 or 2 AA battery or external DC 12V power supply
3. Support internal coil antenna or external SMA antenna for LoRa channel plans
4. Support NA, Europe and China ISM frequency bands (902.3~914.9MHz for US 902-928MHz ISM
Band, 863.1~869.9 MHz for EU 863-870MHz ISM Band, 470.3~489.3MHz for CN 470-510MHz
Band)
5. Support up to 30 sensor types, refer to section 4.1.1.2 for the sensor types
XXX-XXXX
Polysense WxS8000 User Guide
This document provides the guide to use WxS8000.
Polysense, Inc. Confidential
Page 5
Rev 2.3
,
Mar 26
, 2018
User Guide
Revision 0.1
2. WxS8000 Introduction
Diagram 2-1 shows the appearance of WxS8000
XXX-XXXX
Polysense WxS8000 User Guide
Diagram 2-1 WxS8000 Appearance
Diagram 2-2 shows the internal looking of WxS8000
Diagram 2-2 WxS8000 Internal Looking
NOTE:
1. The 2 air flow holes/vents are optional, if there are no install internal
temperature/humidity/CO/sound/pressure sensors installed, then there are no air flow holes
on the enclosure
Polysense, Inc. Confidential
Page 6
Rev 2.3
,
Mar 26
, 2018
User Guide
Revision 0.1
2. The DC cable hole/gland is also optional, if WxS8000 is powered by AA battery, and there is also
no external sensor to be connected to WxS8000, then there is no DC cable hole on the
enclosure
2.1. Antenna
WxS8000 supports internal coil antenna and external antenna, by default, it will use external
antenna, there is a SMA tail cable installed to connect the IPX socket on PCB to external antenna,
user just needs to screw the external antenna to the SMA connector on the enclosure.
2.2. Power source
If AA battery is used as power source, it is strongly recommended to use the 3.6V LI/SOCl2 AA
battery. User can use one AA battery, or 2 AA batteries which can double the life cycle of the
battery power supply.
Please follow the battery polarity mark on PCB to ensure the battery is installed correctly.
Battery power supply and external DC power supply are mutually exclusive; they can’t be used to
power WxS8000 at the same time.
XXX-XXXX
Polysense WxS8000 User Guide
Polysense, Inc. Confidential
Page 7
Rev 2.3
,
Mar 26
, 2018
Region
1 (CN
)
Enable ADR
1 (enabled)
Device EUI
(Refer to the label on
WxS8000
enclosure)
User Guide
Revision 0.1
3. Quick Start
By default, WxS8000 works in OTA (Over The Air) activation mode, below table shows WxS8000
default settings, which are saved in WxS8000 local FLASH and called as PPB (Polysense Personality
Base). For individual WxS8000 specific settings, including MoteEUI, sensor specific configurations,
please refer to Polysense WxS8000 Factory Settings document.
User can follow below procedure to connect WxS8000 to LoRa network:
1. Configure the LoRa server to add the new end-device (or mote) according to WxS8000 default
settings
2. If US902 or CN470 region is being used, then it is necessary to follow below settings to
configure the LoRa gateway upstream channel plan (in order to align with WxS8000 factory
settings):
US902: 902.3, 902.5, 902.7, 902.9, 903.1, 903.3, 903.5, 903.7
CN470: 470.3, 470.5, 470.7, 470.9, 471.1, 471.3, 471.5, 471.7
3. Install the external antenna (screw the external antenna on the SMA connector on enclosure) if
the WxS8000 doesn’t have internal coil antenna installed
XXX-XXXX
Polysense WxS8000 User Guide
4. Power on WxS8000 either via connecting the DC power supply or plugging the 3.6V LI/SOCl2 AA
battery into the battery holder (if the AA battery is used as power source, PLEASE ensure the
AA battery polarities are consistent with the silk-screen on PCB)
NOTE: There is NO AA battery inside WxS8000 box initially
5. WxS8000 starts the OTA join procedure and try to register to the nearby LoRa gateway/server
Item Value
Scheduling granularity 30 seconds
LoRa class 0 (Class A)
Join type 0 (OTA - Over The Air)
Disable PRB (Polysense
Runtime Base)
0 (disabled, so that WxS8000 will always initiate OTA procedure every
time after reboot)
Use fixed device nonce 0 (WxS8000 will use the device nonce generated randomly when
joining the server in OTA mode)
Application EUI 0
Application key 11-22-33-44-55-66-77-88-99-00-AA-BB-CC-DD-EE-FF
Polysense, Inc. Confidential
Page 8
Rev 2.3
,
Mar 26
, 2018
Sensor type 0
0 (Battery Voltage)
Administration state 0
1 (the sensor is ena
bled)
Sample cycle 0
N/A
User Guide
Revision 0.1
Presence 0 1 (the sensor is present on the board)
Scheduling cycle 0 120 (so the sensor scheduling cycle is 30 * 120 = 3600 seconds)
Sample number 0 1 (sample sensor data only for once in each scheduling cycle)
<Sensor type n> Sensor type n specific configuration if applicable
NOTE:
1. If the sample number is set to >= 2, then it will enable the dense data sample for this sensor
type (i.e. the sensor type will be sampled for multiple times as specified by the sample number
in one scheduling cycle)
2. Only Vibration sensor types are supported with dense data sample at this point, including
Vibration with 3-axis and Vibration with 2-axis
XXX-XXXX
Polysense WxS8000 User Guide
Table 3.1-1 WxS8000 PPB default settings
3. It only supports to do the dense data sample for one sensor type at one time, if Vibration with
3-axis and Vibration with 2-axis are both enabled with the dense data sample (both are set as
sample number >=2), then only the Vibration with 2-axis sensor type will be enabled actually
Polysense, Inc. Confidential
Page 9
Rev 2.3
,
Mar 26
, 2018
FRMPayload
CID
Size (bytes)
1
1/4/6/200
User Guide
Revision 0.1
4. WxS8000 Interface with LoRa Server
This chapter defines Polysense WxS8000 interface with LoRa server over the air, the interfaces
include WxS8000 configurations initiated from LoRa server, sensor data report initiated from
WxS8000. The configurations or sensor data report is named as Polysense proprietary messages
which is filled into the FRMPayload in LoRa frame as shown below:
The sensor data in FRMPayload is in binary format
4.1. Downlink Message
The downlink messages initiated from LoRa server are used to configure WxS8000, including
WxS8000 LoRa mote specific configurations, WxS8000 sensor configurations, etc. All the downlink
messages are unconfirmed even though some messages request WxS8000 to give response.
The message type (MType) in MAC header can be 0x03 (Unconfirmed Data Down) or 0x05
(Confirmed Data Down) depending on LoRa server demand
The FPort in the MACPayload is 251 (reserved FPort in LoRa spec)
XXX-XXXX
Polysense WxS8000 User Guide
For the field in FRMPayload, if its length is 2-byte or 4-byte, then it is in little endian, if its length
is 8-byte (APP_EUI and DEVICE_EUI), then it is in big endian. For example,
o For SCHEDULING_CYCLE whose length is 2-byte, if user wants to configure it as 0x0A, then
in FRMPayload, it must be set as 0A00
o For APP_EUI whose length is 8-byte, if user wants to configure it as 0x11223344, then in
FRMPayload, it must be set as 0000000011223344 (the prefixed zeroes are necessary)
The basic formats of downlink message:
o Format#1
Size (bytes)
1
o Format#2
FRMPayload
CID Value
o Format#3
Size (bytes)
1 1 1 0..N
FRMPayload
CID Attribute ValueLength
Value
Polysense, Inc. Confidential
Page 10
Rev 2.3
,
Mar 26
, 2018
0x14
PlssSetPRB
3
Set specific attribute in
WxS8000
PRB
User Guide
Revision 0.1
o CID: command ID to identify one specific command initiated from LoRa server, below table
shows all the commands:
CID Command Format# Comment
0x2 PlssReboot 1 Reboot WxS8000 immediately
0x8 PlssGetInfo 1 Get WxS8000 management information,
0x13 PlssSetPPB 3 Set specific attribute in WxS8000 PPB
0x15 PlssSetClk 2 Set WxS8000 local date-time to align with the
0x19 PlssSetExtCntr 2 Set the counter of the external counter sensor
XXX-XXXX
Polysense WxS8000 User Guide
WxS8000 should respond this with Mote
information report message in next uplink
transmission window
(Polysense Proprietary Base)
(Polysense Runtime Base)
server
to the value specified in Value field
0x1A PlssGetPPB 3 Get specific attribute in WxS8000 PPB, and
there is NO Value parameter in format#3 above
o Value: the value to be set to WxS8000
o Attribute: identify one specific attribute in PPB or PRB
o ValueLength: the length of the value in octet
If the FRMPayload length allows (the MAX FRMPayload length is region-dependent), LoRa
server can pack multiple downlink messages together and fill into the FRMPayload of one LoRa
frame in order to improve the transmission efficiency. Once WxS8000 receives the frame, it will
parse out all the messages, and process one by one.
If there is PlssReboot message inside the FRMPayload which consists of multiple messages,
then WxS8000 won’t execute reboot until all other messages are handled
4.1.1. Set Individual Attribute in PPB (PlssSetPPB)
The change to PPB attributes can take effect immediately except the change of REGION, which will take
effect only after WxS8000 reboot or power recycle.
4.1.1.1. General Attributes
Attribute Description ValueLength
(bytes)
0x2 REGION 1 0 – US902 LoRa region setting. WxS8000 supports all the regions as
Value Comment
defined in LoRaWAN spec 1.0.2, besides WxS8000
Polysense, Inc. Confidential
Page 11
Loading...