Milesight WS101 Smart Button

User Guide

Safety Precautions

Declaration of Conformity

WS101 is in conformity with the essential requirements and other relevant provisions of the CE, FCC, and RoHS.

[CE Logo] [FCC Logo] [Crossed-out Wheelie Bin Logo] [RoHS Logo]

Copyright

Copyright © 2011-2022 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.

Contact Information

For assistance, please contact Milesight technical support:

Email: iot.support@milesight.com

Tel: 86-592-5085280

Fax: 86-592-5023065

Address: Building C09, Software Park III, Xiamen 361024, China

Revision History

Date Doc Version Description
July 12, 2021 V 1.0 Initial version
Dec. 7, 2021 V 1.1 1. Add LoRa D2D controller feature;
2. Delete low power alarm interval, device only uplinks once when battery level is lower than 10%.

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 situation. 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 alarm through Milesight IoT Cloud or through the user's own Application Server.

1.2 Features

2. Hardware Introduction

2.1 Packing List

Diagram showing the contents of the packing list.

If any of the above items is missing or damaged, please contact your sales representative.

2.2 Hardware Overview

Diagram showing the hardware components of the WS101 Smart Button.

2.3 Dimensions (mm)

Diagram showing the dimensions of the WS101 Smart Button: 50mm x 50mm x 18mm.

2.4 LED Patterns

WS101 equips with a LED indicator to indicate the network status and reset button features. Besides, when button is pressed, the indicator will light up at the same time. Red indicator means network is unregistered, while green indicator means device has registered on network.

Function Action LED Indicator
Network Status Send join network requests
Joined the network successfully
Red, blinks once
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 NFC-enabled smartphone.

  1. Pull out the battery insulating sheet to power on the device. The indicator will light up in green for 3 seconds when device turns on.
  2. Download and install “Milesight ToolBox" App from Google Play or App Store.
  3. Enable NFC on the smartphone and open Milesight ToolBox.
  4. Attach the smartphone with NFC area to the device to read device information. Diagram showing a smartphone with NFC symbol near the device.
  5. Basic information and settings of devices 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. In order to protect the security of devices, password validation is required when first configuration. The default password is 123456.

Note:
1) Ensure the location of smartphone NFC area and it's recommended to take off 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 dedicated NFC reader provided by Milesight IoT, you can also configure it via TTL interface inside the device.

3.3 LoRaWAN Settings

LoRaWAN settings are used for configuring the transmission parameters in LoRaWAN® network.

Basic LoRaWAN Settings:

Go to Device -> Setting -> LoRaWAN Settings of ToolBox App to configure join type, App EUI, App Key and other information. You can also keep all settings 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 ACK packet from network server, it will resend data 3 times at most.
Rejoin Mode Reporting interval ≤ 30 mins: device will send specific mounts of LoRaMAC packets to check connection status every 30 mins; If no reply after specific packets are being sent, the device will re-join.
Reporting interval > 30 mins: device will send specific mounts of LoRaMAC packets to check connection status at every reporting interval; If no reply after specific packets are being sent, the device will re-join.
ADR Mode Allow network server to adjust datarate of the device.
Tx Power Transmit power of device.

Note:
1) Please contact sales representative for device EUI list if there are many units.
2) Please contact 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 of ToolBox App to select supported frequency and select channels to send uplinks. Make sure the channels match the LoRaWAN® gateway.

If 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, making them 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 model, default frequency is EU868;
For -915M model, default frequency is AU915.

3.4 General Settings

Go to Device->Setting->General Settings of ToolBox App to change the reporting interval, etc.

Parameters Description
Reporting Interval Reporting interval of battery level to network server. Default: 1080min, Range: 1-1080 mins
LED Indicator Enable or disable the light indicating in chapter 2.4. Note: The indicator of reset button is not allowed to disable.
Buzzer The buzzer will be triggering together with indicator if the device is registered to network.
Change Password Change the password for ToolBox App to write this device.

3.5 LoRa D2D Settings

LoRa D2D protocol is developed by Milesight and used for setting up transmission among Milesight devices without gateway. When the LoRa D2D setting is enabled, WS101 can work as a LoRa D2D controller to send control commands to trigger LoRa D2D agent devices.

  1. Enable LoRa D2D feature.
  2. Define a unique LoRa D2D key which is the same as LoRa D2D agent devices, then select the frequency and spreading factor. (Default LoRa D2D Key: 5572404C696E6B4C6F52613230313823)
  3. Enable one of WS101 button mode and configure a 2-byte hexadecimal command (This command is pre-defined in LoRa D2D agent device). When you press as this button mode, WS101 will send the control command to corresponding LoRa D2D agent devices.

Note: When this feature is enabled, the device will not send uplinks to LoRaWAN® network server.

Enable LoRa D2D Key Spread Factor Frequency/MHz
LoRa D2D Settings [Toggle Switch On] ******************************** SF12-DR0 9.525

Button Mode Configuration for LoRa D2D:

Button Mode Control command
Short Press 0001
Long Press ff01
Double Press [Toggle Switch Off]

3.6 Maintenance

3.6.1 Upgrade

  1. Download firmware from Milesight website to your smartphone.
  2. Open ToolBox App and click “Browse” to import firmware and upgrade the device.

Note:
1) Operation on ToolBox is not supported during upgrade.
2) Only Android version ToolBox supports the upgrade feature.

Status Setting Maintenance
SN 6535B1712972
Model WS101-915M
Firmware Version V1.1-a01
Hardware Version V1.0
Manual Upgrade [Browse Button]

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.

  1. Go to "Template” page on the App and save current settings as a template. You can also edit the template file.
  2. Select one template file that saved in the smartphone and click “Write”, then attach it to another device to write configuration.

Screenshot showing template management in the app, including options to create new templates, edit, and delete existing ones.

3.5.3 Reset to Factory Default

Please select one of the following methods to reset device:

4. Installation

3M Tapes Fix:

Paste 3M tape to the back of the button, then tear the other side and place it on a flat surface. Diagram showing application of 3M tape to the device and mounting it.

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 back the device. Diagram showing wall plugs being screwed in and the device cover being attached with screws.

Lanyard:

Pass the lanyard through the aperture near the edge of the button, then you can hang the button onto keychains and the like. Diagram showing a lanyard being attached to the device.

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 at https://github.com/Milesight-IoT/SensorDecoders.

5.1 Basic Information

WS101 reports basic information of button whenever joining the network.

Channel Type Description
ff 01(Protocol Version) 01=> V1
ff 08 (Device SN) 12 digits
ff 09 (Hardware Version) 01 40 => V1.4
ff 0a (Software Version) 01 14 => V1.14
ff 0b (Power On) Device is on
ff 0f (Device Type) 00: Class A, 01: Class B, 02: Class C

Example: ff0bff ff0101 ff086538b2232131 ff090100 ff0a0102 ff0f00

Channel Type Value Channel Type Value
ff 0b (Power On) 01 (V1) ff 01 (Protocol Version) 01 (V1)
ff 08(Device SN) 6538b2232131 ff 09 (Hardware version) 0100 (V1.0)
ff 0a (Software version) 0102 (V1.2) ff 0f (Device Type) 00 (Class A)

5.2 Button Message

WS101 reports battery level according to reporting interval (1080 mins by default) and button message when button is pressed. Besides, when battery level is lower than 10%, it will upload battery package once.

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 Description
ff 03 (Set Reporting Interval) 2 Bytes, unit: s

Example: Set reporting interval as 20 minutes.

Channel Type Value
ff 03 (Set Reporting Interval) b0 04 => 04 b0 = 1200s = 20 minutes

-END-

Models: WS101, Smart ButtonFeaturing LoRaWAN

File Info : application/pdf, 16 Pages, 670.52KB

PDF preview unavailable. Download the PDF instead.

ws101-user-guide-en

References

WPS Office

Related Documents

Preview Milesight WS101 Smart Button LoRaWAN User Guide
User guide for the Milesight WS101 Smart Button featuring LoRaWAN technology. Covers product introduction, hardware overview, operation, configuration (NFC, LoRaWAN), installation, maintenance, and device payload.
Preview Milesight DS3604 IoT E-ink Display User Guide | LoRaWAN Configuration and Operation
Comprehensive user guide for the Milesight DS3604 IoT E-ink Display. Covers LoRaWAN settings, NFC configuration, general settings, maintenance, installation, and device payload for efficient IoT deployments.
Preview Milesight WS136 & WS156 Smart Scene Panel User Guide | LoRaWAN Control
Comprehensive user guide for the Milesight WS136 and WS156 Smart Scene Panel, detailing features, installation, configuration via NFC and LoRaWAN, device payload, and maintenance. Learn how to set up and manage your smart scene panels for IoT applications.
Preview Milesight AM100 Series Indoor Ambiance Sensor User Guide
Comprehensive user guide for the Milesight AM100 Series indoor ambiance sensors (AM104, AM107), detailing features, hardware overview, operation, installation, and Milesight IoT Cloud integration. Learn about LoRaWAN settings, calibration, maintenance, and sensor data.
Preview Milesight Smart Building Kit Datasheet: IoT Solutions for Modern Buildings
Explore the Milesight Smart Building Kit, a comprehensive IoT solution featuring LoRaWAN and D2D technology for enhanced connectivity, monitoring, and control in smart buildings. Includes datasheets for sensors, controllers, and gateways.
Preview Milesight VS350 Passage People Counter User Guide
Comprehensive user guide for the Milesight VS350 Passage People Counter, detailing its features, hardware overview, operation, installation, maintenance, and data payload for LoRaWAN networks. Includes setup instructions for NFC, LoRaWAN, and Milesight D2D protocols.
Preview Milesight UC50x Series LoRaWAN Controller User Guide
Comprehensive user guide for the Milesight UC50x Series LoRaWAN Controller, detailing its features, hardware setup, operation, configuration via NFC and USB, LoRaWAN and interface settings, maintenance, installation, and cloud management.
Preview Milesight EM300 Series Environment Monitoring Sensor User Guide
Explore the Milesight EM300 Series Environment Monitoring Sensors with this comprehensive user guide. Learn about features, NFC and LoRaWAN configuration, installation, and Milesight IoT Cloud integration for efficient outdoor environmental monitoring.