Milesight WS101 Smart Button 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 modified in any way.
- Do not place the device close to objects with naked flames.
- Do not place the device where the temperature is below/above the operating range.
- When installing the battery, please install it accurately, and do not install the reverse or wrong model.
- Remove the battery if the device will not be used for a period of time. Otherwise, the battery will leak and damage the device.
- The device must never be subjected to shocks or impacts.
Declaration of Conformity
WS101 is in conformity with the essential requirements and other relevant provisions of the CE, FCC, and RoHS.
[CE compliance mark] [FCC compliance mark] [RoHS compliance mark]
Copyright © 2011-2021 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
For assistance, please contact Milesight technical support:
Email: iot.support@milesight.com
Tel: 86-592-5085280
Fax: 86-592-5023065
Address: 4/F, No.63-2 Wanghai Road, 2nd Software Park, Xiamen, China
Revision History
Date | Doc Version | Description |
July 12, 2021 | V 1.0 | Initial version |
1. Product Introduction
1.1 Overview
WS101 is a LoRaWAN® based smart button for wireless controls, triggers and alarms. WS101 supports multiple press actions, all of which can be defined by the user to control devices or trigger scenes. Besides, Milesight also provides a red button version that is primarily used for emergency situations. Compact and battery-powered, WS101 is easy to install and carry everywhere. WS101 can be widely used in smart homes, smart offices, hotels, schools, etc.
Sensor data are transmitted in real-time using the standard LoRaWAN® protocol. LoRaWAN® enables encrypted radio transmissions over long distances while consuming very little power. The user can get alarms through Milesight IoT Cloud or through the user's own Application Server.
1.2 Features
- Up to 15 km communication range
- Easy configuration via NFC
- Standard LoRaWAN® support
- Milesight IoT Cloud compliant
- Support multiple press actions to control devices, trigger a scene or send emergency alarms
- Compact design, easy to install or carry
- Built-in LED indicator and buzzer for press actions, network status, and low battery indication
2. Hardware Introduction
2.1 Packing List
The packing list includes:
- 1 x WS101 Sensor
- 2 x Wall Mounting Kits
- 1 x 3M Tape
- 1 x Quick Guide
If any of the above items is missing or damaged, please contact your sales representative.
2.2 Hardware Overview
The device features an NFC Area, an Indicator Button, a Lanyard Hole, a Reset Button, a Battery compartment, and Mounting Holes.
2.3 Dimensions (mm)
The device is square with dimensions of 50mm x 50mm and a height of 18mm.
2.4 LED Patterns
WS101 equips a LED indicator to show network status and reset button features. When the button is pressed, the indicator lights up simultaneously. A red indicator signifies that the network is unregistered, while a green indicator means the device has registered on the network.
Function | Action | LED Indicator |
Network Status | Send join network requests | Red, blinks once |
Joined the network successfully | Green, blinks twice | |
Reboot | Press and hold the reset button for more than 3s | Slowly blinks |
Reset to Factory Default | Press and hold the reset button for more than 10s | Quickly blinks |
3. Operation Guide
3.1 Button Mode
WS101 provides 3 kinds of pressing actions allowing users to define different alarms. Please refer to chapter 5.1 for detailed message of every action.
Mode | Action |
Mode 1 | Short press the button (≤3 seconds). |
Mode 2 | Long press the button (>3 seconds). |
Mode 3 | Double press the button. |
3.2 NFC Configuration
WS101 can be configured via an NFC-enabled smartphone.
- Pull out the battery insulating sheet to power on the device. The indicator will light up in green for 3 seconds when the device turns on.
- Download and install the "Milesight ToolBox" App from Google Play or App Store.
- Enable NFC on the smartphone and open Milesight ToolBox.
- Attach the smartphone with its NFC area to the device to read device information. A diagram shows a smartphone with its NFC area positioned near the Milesight WS101 device, indicated by an [NFC symbol].
- Basic information and settings of the device will be shown on ToolBox if it's recognized successfully. You can read and configure the device by tapping the Read/Write button on the App. To protect device security, password validation is required when configuring via a new smartphone. The default password is 123456.
Note: 1) Ensure the location of the smartphone's NFC area and it's recommended to take off the phone case. 2) If the smartphone fails to read/write configurations via NFC, move the phone away and back to try again. 3) WS101 can also be configured by ToolBox software via a dedicated NFC reader provided by Milesight IoT, or via the TTL interface inside the device.
3.3 LoRaWAN Settings
LoRaWAN settings are used for configuring the transmission parameters in a LoRaWAN® network. Basic LoRaWAN Settings can be configured via Device -> Setting -> LoRaWAN Settings in the ToolBox App to set join type, App EUI, App Key, and other information. All settings can also be kept by default.
Parameters | Description |
Device EUI | Unique ID of the device, which can also be found on the label. |
App EUI | Default App EUI is 24E124C0002A0001. |
Application Port | The port used for sending and receiving data, default port is 85. |
Join Type | OTAA and ABP modes are available. |
Application Key | Appkey for OTAA mode, default is 5572404C696E6B4C6F52613230313823. |
Device Address | DevAddr for ABP mode, default is the 5th to 12th digits of SN. |
Network Session Key | Nwkskey for ABP mode, default is 5572404C696E6B4C6F52613230313823. |
Application Session Key | Appskey for ABP mode, default is 5572404C696E6B4C6F52613230313823. |
Spread Factor: If ADR is disabled, the device will send data via this spread factor.
Confirmed Mode: If the device does not receive an ACK packet from the network server, it will resend data 3 times at most.
Rejoin Mode: If the reporting interval is ≤ 30 mins, the device will send specific LoRaMAC packets to check connection status every 30 mins; if there is no reply after specific packets are sent, the device will re-join. If the reporting interval is > 30 mins, the device will send specific LoRaMAC packets to check connection status at every reporting interval; if there is no reply after specific packets are sent, the device will re-join.
ADR Mode: Allows the network server to adjust the datarate of the device.
Tx Power: Transmit power of the device.
Note: 1) Please contact the sales representative for a device EUI list if there are many units. 2) Please contact the sales representative 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.
LoRaWAN Frequency Settings
Go to Setting->LoRaWAN Settings in the ToolBox App to select the supported frequency and channels to send uplinks. Ensure the channels match the LoRaWAN® gateway.
If the device frequency is one of CN470/AU915/US915, you can enter the index of the channel that you want to enable in the input box, separated by commas.
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: Indicates that all channels are disabled.
Note: For -868M models, the default frequency is EU868; for -915M models, the default frequency is AU915.
3.4 General Settings
Go to Device->Setting->General Settings in the ToolBox App to change the reporting interval, etc.
Parameters | Description |
Reporting Interval | Reporting interval of battery level to the network server. Default: 1080min. |
LED Indicator | Enable or disable the light indicating, as described in chapter 2.4. Note: The indicator of the reset button is not allowed to disable. |
Buzzer | The buzzer will trigger together with the indicator if the device is registered to the network. |
Low Power Alarm Interval | The button will report low power alarms according to this interval when the battery is lower than 10%. |
Change Password | Change the password for the ToolBox App to write to this device. |
3.5 Maintenance
3.5.1 Upgrade
- Download firmware from the Milesight website to your smartphone.
- Open the ToolBox App and click "Browse" to import firmware and upgrade the device.
Note: 1) Operation on ToolBox is not supported during upgrade. 2) Only the Android version of ToolBox supports the upgrade feature.
A screenshot shows device status fields including SN (653581712972), Model (WS101-915M), Firmware Version (V1.1-001), Hardware Version (V1.0), and buttons for Manual Upgrade and Browse.
3.5.2 Backup
WS101 supports configuration backup for easy and quick device configuration in bulk. Backup is allowed only for devices with the same model and LoRa frequency band.
- Go to the "Template" page on the App and save current settings as a template. You can also edit the template file.
- Select one template file saved on the smartphone and click "Write", then attach it to another device to write the configuration.
Screenshots show a template creation dialog with fields for template name (e.g., "Temp & Hum Sensor") and buttons for Cancel and OK. Another screenshot displays a list of saved templates with options to Edit and Delete.
3.5.3 Reset to Factory Default
Please select one of the following methods to reset the device:
- Via Hardware: Hold the reset button for more than 10s. After reset is complete, the indicator will blink green twice and the device will reboot.
- Via ToolBox App: Go to Device -> Maintenance, tap "Reset", then attach the smartphone with its NFC area to the device to complete the reset.
4. Installation
3M Tapes Fix
Paste 3M tape to the back of the button, then tear off the other side and place it on a flat surface. Diagrams illustrate applying 3M tape to the device back, peeling the protective layer, and placing it on a surface.
Screw Fix
Remove the back cover of the button, screw the wall plugs into the wall, and fix the cover with screws on it, then install the device back. Diagrams show removing the back cover, inserting wall plugs, fixing the cover with screws, and reattaching the device.
Lanyard
Pass the lanyard through the aperture near the edge of the button, then you can hang the button onto keychains and the like.
5. Device Payload
All data are based on the following format (HEX):
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, you can find them at https://github.com/Milesight-IoT/SensorDecoders.
5.1 Basic Information
WS101 reports basic information of the button every time it joins the network.
Channel | Type | Data Example | Description |
ff | 01(Protocol Version) | 01 | V1 |
08 (Device SN) | 61 27 a2 17 41 32 | Device SN is 6127a2174132 | |
09 (Hardware Version) | 01 40 | V1.4 | |
0a (Software Version) | 01 14 | V1.14 | |
0f(Device Type) | 00 | Class A |
Example: ff 09 01 00 ff 0a 01 02 ff 0f 00
Channel | Type | Value | Channel | Type | Value | |||
ff | 09 (Hardware version) | 0100 (V1.0) | ff | 0a (Software version) | 0102 (V1.2) | |||
Channel | Value | |||||||
ff | 0f (Device Type) | 00 (Class A) |
5.2 Button Message
WS101 reports battery level according to the reporting interval (1080 mins by default) and button message when the button is pressed.
Channel | Type | Description |
01 | 75(Battery Level) | UINT8, Unit: % |
ff | 2e(Button Message) | 01: Mode 1 (short press) 02: Mode 2 (long press) 03: Mode 3 (double press) |
Example: 01 75 64
Channel | Type | Value |
01 | 75 (Battery) | 64 => 100% |
Example: ff 2e 01
Channel | Type | Value |
ff | 2e(Button Message) | 01 => short press |
5.3 Downlink Commands
WS101 supports downlink commands to configure the device. The application port is 85 by default.
Channel | Type | Data Example | Description |
ff | 03(Set Reporting Interval) | b0 04 | b0 04 => 04 b0 = 1200s |
-END-