User Guide for Milesight models including: WS558 Smart Light Controller, WS558, Smart Light Controller, Light Controller, Controller
Milesight WS558-SW - Airteq
File Info : application/pdf, 25 Pages, 2.25MB
DocumentDocumentSmart Light Controller Featuring LoRaWAN® WS558 User Guide Safety Precautions Milesight will not shoulder responsibility for any losses or damages resulting from not following the instructions of this operating guide. The device must not be modified in any way. To protect the security of the device, please change device the password when first configuration. The default password is 123456. The installation and maintenance must be conducted by a qualified service person and should strictly comply with the electrical safety regulations of the local region. Ensure power is off during the installation. For the LN model, do not reverse the Live Wire (L) and Neutral (N) wire. To get the best data transmission, ensure the device is within the signal range of the LoRaWAN® gateway and keep it away from metal objects and obstacles. Do not overload the maximum capacity to avoid damage to the device. The device is intended only for indoor use. 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 (oven or sunlight), cold source, liquid and extreme temperature changes. Keep the device away from water to prevent electric shock. Use the device only in a clean environment. Dusty or dirty environments may prevent the proper operation of this device. Do not drop the device or subject it to physical shocks and strong vibration. Declaration of Conformity WS558 is in conformity with the essential requirements and other relevant provisions of the CE, FCC, and RoHS. 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. 2 Revision History Date July 20, 2022 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 Doc Version Description V 2.0 Initial version 3 Contents 1. Product Introduction ......................................................................................................................... 5 1.1 Overview ...................................................................................................................................5 1.2 Features ................................................................................................................................... 5 2. Hardware Introduction ...................................................................................................................... 5 2.1 Packing List ..............................................................................................................................5 2.2 Hardware Overview ................................................................................................................. 6 2.4 Dimensions (mm) .................................................................................................................... 7 3. Operation Guide .................................................................................................................................7 3.1 ToolBox Login .......................................................................................................................... 7 3.1.1 NFC Configuration ........................................................................................................ 7 3.1.2 USB Configuration ........................................................................................................ 8 3.2 LoRaWAN Settings .................................................................................................................. 9 3.2.1 Basic Settings ............................................................................................................. 10 3.2.2 Frequency Settings .....................................................................................................11 3.2.3 Multicast Settings .......................................................................................................12 3.3 General Settings .................................................................................................................... 15 3.4 Milesight D2D Settings ..........................................................................................................15 3.5 Maintenance .......................................................................................................................... 16 3.5.1 Upgrade ....................................................................................................................... 16 3.5.2 Backup .........................................................................................................................17 3.5.3 Reset to Factory Default .............................................................................................19 4. Installation ....................................................................................................................................... 19 5. Device Payload ................................................................................................................................ 20 5.1 Basic Information .................................................................................................................. 20 5.2 Sensor Data ........................................................................................................................... 21 5.3 Downlink Commands ............................................................................................................ 22 4 1. Product Introduction 1.1 Overview WS558 is a LoRaWAN® Smart Light Controller for the monitoring and control of lights. With 2 circuit types and 8 switches, WS558 can fit in different rooms without the need for re-wirings and reduce the renovation costs. Besides LoRaWAN®, WS558 can be controlled whithout a gateway via Milesight D2D communication protocol, which sets up a connection quickly. WS558 can be widely used for wireless control of indoor lights, fans, heaters, machines, etc. Power data and switch status are transmitted via LoRaWAN® protocol, and LoRaWAN® technology enables encrypted radio transmissions over long distances while consuming very little power. Also, users can check visualized data through Milesight IoT Cloud or the user's own Application Server. 1.2 Features LN type or switch type optional, controls up to 8 circuits of lights, adopts different indoor wiring Support local switch button control, able to test the lamp status without networking Collect data on current, voltage, electrical consumption Up to 15 km communication range Easy configuration via NFC Standard LoRaWAN® technology Compatible with Milesight IoT Cloud and Milesight ToolBox Support Milesight D2D protocol to enable ultra-low latency control without gateway Support multicast for control in bulk 2. Hardware Introduction 2.1 Packing List 1× 4× WS558 Controller Wall Mounting Kits 1× Quick Guide 1× Warranty Card If any of the above items is missing or damaged, please contact your sales representative. 5 2.2 Hardware Overview All circuits/switches are open with their LED indicator off by default. You can press the button beneath their LED indicator to close a circuit/switch, and the LED indicator will be lit on as the lamp connected to this circuit/switch. 2.3 Wiring Diagram LN Model: 6 Switch Model: 2.4 Dimensions (mm) 3. Operation Guide 3.1 ToolBox Login WS558 can be configured via NFC or Type-C port. Please select one of them to complete the configuration. 3.1.1 NFC Configuration 1. Download and install "Milesight ToolBox" App from Google Play or Apple App Store. 2. Enable NFC on the smartphone and launch Milesight ToolBox. 3. Attach the smartphone with the NFC area to the device to read device information. Basic 7 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. To protect the security of the device, password validation is required when first configuration. The default password is 123456. Note: 1) Check the NFC area of your smartphone and it's recommended to remove the phone case. 2) If the smartphone fails to read/write configurations via NFC, move the phone away and back to try again. 3) WS558 can also be configured on ToolBox via a dedicated NFC reader provided by Milesight IoT. 3.1.2 USB Configuration 1. Download ToolBox software from www.milesight-iot.com. 2. Connect the device to a computer via the Type-C port. Please note that do not touch the power interface, switches and other wirings to avoid electric shock. 3. Open the ToolBox and select type as "General", then click password to log into the ToolBox. (Default password: 123456) 8 4. After logging into the ToolBox, you can check device status and change device settings. 3.2 LoRaWAN Settings LoRaWAN settings are used to configure the data transmission parameters in the LoRaWAN® network. 9 3.2.1 Basic Settings WS558 supports basic configurations like join type, App EUI, App Key and other information. You can also keep all settings by default. Parameters Device EUI App EUI Application Port Join Type Application Key Device Address Network Session Key Application Session Key RX2 Data Rate RX2 Frequency/MHz Spread Factor Description Unique ID of the device which can also be found on the label. Default App EUI is 24E124C0002A0001. The port used for sending and receiving data, default port is 85. OTAA and ABP modes are available. Appkey for OTAA mode, default is 5572404C696E6B4C6F52613230313823. DevAddr for ABP mode, default is the 5th to 12th digits of SN. Nwkskey for ABP mode, default is 5572404C696E6B4C6F52613230313823. Appskey for ABP mode, default is 5572404C696E6B4C6F52613230313823. RX2 data rate to receive downlinks or Milesight D2D commands. RX2 frequency to receive downlinks or Milesight D2D commands. If ADR is disabled, the device will send data via this spread factor. 10 Confirmed Mode Rejoin Mode ADR Mode Tx Power If the device does not receive the ACK packet from network server, it will resend data once. Reporting interval 30 mins: the device will send a specific number of LinkCheckReq MAC packets to the network server every 30 mins to validate connectivity; If there is no response, the device will re-join the network. Reporting interval > 30 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. Allow the network server to adjust the data rate of the device. Transmit power of the device. Note: 1) Please contact your sales representative for device EUI list if there are many units. 2) Please contact your 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. 3.2.2 Frequency Settings Select supported frequency and channels to send uplinks. Make sure the channels match the LoRaWAN® gateway. 11 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, 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, the default frequency is EU868; For -915M model, the default frequency is AU915. 3.2.3 Multicast Settings WS558 supports setting up several multicast groups to receive multicast commands from network servers and users can use this feature to control devices in bulks. 1. Enable Multicast Group on WS558, set a unique multicast address and keys to distinguish other groups. You can also keep these settings by default. 12 Parameters Description Multicast Address Unique 8-digit address to distinguish different multicast groups. 32-digit key. Default values: Multicast McAppSkey Multicast Group 1: 5572404C696E6B4C6F52613230313823 Multicast Group 2: 5572404C696E6B4C6F52613230313824 Multicast Group 3: 5572404C696E6B4C6F52613230313825 Multicast Group 4: 5572404C696E6B4C6F52613230313826 32-digit key. Default values: Multicast McNetSkey Multicast Group 1: 5572404C696E6B4C6F52613230313823 Multicast Group 2: 5572404C696E6B4C6F52613230313824 Multicast Group 3: 5572404C696E6B4C6F52613230313825 Multicast Group 4: 5572404C696E6B4C6F52613230313826 2. Add a multicast group on the network server. Take Milesight UG6x gateway as example, go to "Network Server -> Multicast Groups", click "Add" to add a multicast group. Fill in the multicast group information the same as WS558 settings, and select the devices which you need to control, then click "Save". 13 3. Go to "Network Server -> Packets", select the multicast group and fill in the downlink command, click "Send". The network server will broadcast the command to devices which belong to this multicast group. Note: ensure all devices' application ports are the same. 14 3.3 General Settings Parameters Description The interval of reporting switch status and electrical parameters. Reporting Interval Default: 20 mins, Range: 1 - 1080 mins The device returns to the power supply state If the device loses power and returns to power supply, all switches or outputs status will change according to this parameter. Change the password of the device for ToolBox App or software Change Password configuration. 3.4 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, WS558 can work as Milesight D2D agent device to receive commands from Milesight D2D controller devices. 1. Ensure the RX2 datarate and RX2 frequency in LoRaWAN settings are the same as the Milesight D2D controller device. 2. Enable the Milesight D2D feature, and define a unique Milesight D2D key to be the same as the setting in Milesight D2D controller device. (Default Milesight D2D Key: 5572404C696E 6B4C6F52613230313823) 3. Define a 2-byte hexadecimal control command (0x0000 to 0xffff) and command action. For example, you can configure a control command 0001 to inverse Output channel 2 as below. WS558 supports at most 16 control commands. 15 4. These control commands can be configured in Milesight D2D controller device. When Milesight D2D controller device is triggered, it will send the pre-defined control command to control the circuits/switches of WS558 to on, off or inverse status. 3.5 Maintenance 3.5.1 Upgrade ToolBox Software: 1. Download firmware from www.milesight-iot.com to your PC. 2. Go to "Maintenance -> Upgrade" of ToolBox software, click "Browse" to import firmware and upgrade the device. You can also click "Up to Date" to search for the latest firmware of the device and upgrade. 16 ToolBox App: 1. Download firmware from www.milesight-iot.com 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 the upgrade. 2) Only the Android version ToolBox supports the upgrade feature. 3.5.2 Backup WS558 supports configuration backup for easy and quick device configuration in bulk. Backup is allowed only for devices with the same model and LoRaWAN® frequency band. ToolBox Software: 1. Go to "Maintenance -> Backup and Reset" of ToolBox software, click "Export" to backup the device configuration. 2. Click "Browse" to import the backup file, then click "Import" to load the configuration. 17 ToolBox App: 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 saved in the smartphone and click "Write", then attach it to another device to write configuration. Note: Slide the template item to the left to edit or delete it. Click the template to edit the configurations. 18 3.5.3 Reset to Factory Default Please select one of the following methods to reset the device: Via ToolBox Software: Go to "Maintenance -> Backup and Reset" of ToolBox software, click "Reset" to complete. Via ToolBox App: Go to "Device -> Maintenance" to tap "Reset", then attach smartphone with NFC area to the device to complete. 4. Installation Wall Mounting Fix the wall plugs into the wall, then fix the device to the wall plugs with screws. DIN Rail Mounting Fix the device to DIN rail via the groove on the back of the device. 19 5. Device Payload All data are based on the following format (HEX), the Data field should follow 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 you can find at https://github.com/Milesight-IoT/SensorDecoders. 5.1 Basic Information WS558 reports basic information of the device whenever it joins the network. Channel Type 01(Protocol Version) 09 (Hardware Version) 0a (Software Version) ff 0b (Power On) 0f (Device Type) 16 (Device SN) 26 (Power Consumption) Description 01 => V1 01 40 => V1.4 01 14 => V1.14 Device is on 00: Class A, 01: Class B, 02: Class C 16 digits 00-disabled, 01-enabled Example: ff0bff ff0101 ff166756c22186300001 ff090200 ff0a0101 ff0f02 ff2601 Channel ff Channel ff Type 0b (Power On) Type 16(Device SN) Value ff (Reserved) Value 6756c22186 300001 Channel ff Channel ff Type 01 (Protocol Version) Type 09 (Hardware Version) Value 01(V1.0) Value 0200 (V2.0) 20 Channel ff Channel ff Type 0a (Software Version) Type 26 (Power Consumption) Value 0101 (V1.1) Value 01=>Enabled Channel ff Type 0f (Device Type) Value 02=>Clas sC 5.2 Sensor Data WS558 reports switch status and electrical data according to reporting interval (20 mins by default). For Switch model, it only uploads switch status. Channel 03 04 05 06 07 08 Type 74 (Voltage) 80 (Active Power) 81 (Power Factor) 83 (Power Consumption) c9 (Total Current) 31 (Switch Status) Description UINT16, Unit: V Resolution: 0.1V UINT32, Unit: W UINT8, Unit: % UINT32, Unit: Wh UINT16, Unit: mA Byte 1: 00 Byte 2: indicate every switch status per bit, 0=close, 1=open Example: 1. Periodic package: 08310001 058164 07c90200 0374b208 068301000000 048001000000 Channel 08 Channel 07 Channel 06 Type 31 (Switch Status) Type c9 (Current) Type 83(Power Consumption) Value Byte 1: 00 Byte 2: 01= 00000001 => L1 open and others close Value 02 00=>00 02=2mA Value 01 00 00 00=>00 00 00 01=1 Wh=0.001 kWh Channel 05 Channel 03 Channel 04 Type 81 (Power Factor) Type 74(Voltage) Type 80 (Active Power) Value 64=> 100% Value b2 08=>08 b2=2226 Voltage=2226 *0.1=222.6V Value 01 00 00 00=>00 00 00 01=1 W 21 2. When any switch changes status: Channel 08 08310060 Type 31 (Switch Status) Value Byte 1: 00 Byte 2: 60= 0110 0000 => L6, L7 open and others close 3. When LN model device detects the current over 13A for more than 30s, all switches will close and upload alarm package: Channel Type 07 c9 (Current) 07c9413f 08310000 Value 41 3f=>3f 41=16193 mA=16.193A Channel 08 Type 31 (Switch Status) Value Byte 1: 00 Byte 2: 00 =>All close 5.3 Downlink Commands WS558 supports downlink commands to configure the device. The application port is 85 by default. Channel Type 08 - 03 (Set Reporting Interval) 10 (Reboot Device) ff 32 (Add Delay Task) 23 (Delete Delay Task) 26 (Power Consumption) Description Byte 1: every switch control status per bit, 0=not allow control, 1=allow control Byte 2: every switch status per bit, 0=close, 1=open 2 Bytes, unit: s ff Byte 1: 00 Byte 2-3: delay time, unit: s Byte 4: every switch control status per bit, 0=not allow control, 1=allow control Byte 5: every switch status per bit, 0=close, 1=open Note: WS558 supports adding only one task. Later command will cover previous command. 00 ff 00-disable, 01-enable 22 27 (Reset Power Consumption) ff 28 (Enquire Electrical Status) ff Example: 1. Close L1 and open L6. Channel 08 Type - 082120 Command Byte 1: 21=0010 0001 =>L1 and L6 allow control Byte 2: 20 = 0010 0000 => L1 close, L6 open 2. Close all switches. Channel 08 Type - 08ff00 Command Byte 1: ff=1111 1111 =>All switches allow control Byte 2: 00 = 0000 0000 =>All switches close 3. Set reporting interval as 20 minutes. Channel ff ff03b004 Type 03 (Set Reporting Interval) Value b0 04=>04 b0=1200s =20 minutes 4. Add a delay task: close L6 after 1minute Channel ff Type 32 (Add Delay Task) ff32003c002000 Value Byte 1:00 Byte 2-3: 3c 00=>00 3c=60s=1min Byte 4: 20=>Bit6=1=>Control L6 Byte 5: 00=>Bit6=0=>L6 close 5. Delete the delay task Channel ff ff2300ff Type 23(Delete Delay Task) Value 00ff 6. Disable the collection and upload of power consumption. ff2600 23 Channel ff Type 26 (Power Consumption) Value 00 = disable 7. Reset power consumption Channel ff ff27ff Type 27(Reset Power Consumption) Value ff (Reserved) -END- 24 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