Ubisys ZIGBEE S2(-R) Reference Manual
  1. Manuals
  2. Brands
  3. Ubisys Manuals
  4. Switch
  5. ZIGBEE S2(-R)
  6. Reference manual

Ubisys ZIGBEE S2(-R) Reference Manual

Hide thumbs Also See for ZIGBEE S2(-R):
Table of Contents

Advertisement

Quick Links

Download this manual
ZIGBEE POWER SWITCH S2(-R)
REFERENCE MANUAL
u

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the ZIGBEE S2(-R) and is the answer not in the manual?

Questions and answers

Related Manuals for Ubisys ZIGBEE S2(-R)

Summary of Contents for Ubisys ZIGBEE S2(-R)

  • Page 1 ZIGBEE POWER SWITCH S2(-R) REFERENCE MANUAL ...
  • Page 2 OVERVIEW Thank you for purchasing the ubisys power switch S2, a ZigBee dual load switch with integrated smart meter. You have decided for a high-quality product with first-rate support! This reference manual provides operating and maintenance instructions, interface specifications, command references and more. It is primarily intended for system integrators, not end-users.
  • Page 3 Application Endpoint #3 – Primary Level Control Switch 7.4.1. Basic Cluster (Server) 7.4.2. Identify Cluster (Server) 7.4.3. Scenes Cluster (Client) 7.4.4. On/off Cluster (Client) 7.4.5. Level Control Cluster (Client) 7.5. Application Endpoint #4 – Secondary Level Control Switch 7.5.1. Basic Cluster (Server) 7.5.2. Identify Cluster (Server) www.ubisys.de...

  • Page 4: Table Of Contents

    7.7.5. Device Setup Cluster (Server) 7.8. Application Endpoint #242 – ZigBee Green Power 7.8.1. Green Power Cluster (Server) 7.8.2. Green Power Cluster (Client) Physical Dimensions Ordering Information General Terms & Conditions of Business Declaration of Conformity Revision History Contact www.ubisys.de...
  • Page 5 On-board PHY: Texas Instruments CC2520, 5dBm transmit power, -98dBm receiver sensitivity On-board inverted-F antenna Leverages ubisys IEEE 802.15.4 MAC and ZigBee stack for best-in-class reliability and performance Supports all channels in the 2.4 GHz band, i.e. channels 11-26 as per IEEE 802.15.4: Primary = { 11, 15, 20, 25 };...
  • Page 6 S2 (marked “N”, blue). Once powered, you should observe the normal device start-up behaviour (the green LED will flash a few times). If you are not using a safe low-voltage power-supply, utilizing the services of a professional installer/electrician is imperative. www.ubisys.de...
  • Page 7 After joining a network, the device will prolong the joining window by three minutes via a fresh ZDO permit joining request Stretching the joining duration is done in products with ubisys ZigBee Stack version 1.48 or above. www.ubisys.de...
  • Page 8 The 10-second-press factory reset (equivalent to menu item #5) is available since firmware version 1.04. Notice: Prior versions have different menu items. Only the factory reset command (menu item #5) is identical across all released versions of the firmware. www.ubisys.de...
  • Page 9 4. Repeat the previous step two more times, for a total of three short power cycles. 5. Apply power to the device and leave it powered on. The device will now factory reset and reboot. Since application firmware 1.05. Previously, the factory reset would result in a silent leave. Since application firmware 1.08 www.ubisys.de...
  • Page 10 Since application version 1.13 (S2). Prior, On/off output (0x0002) was used, which more accurately reflects the nature of the device, but is ignored by a major connected lighting eco-system, which refuses to control generic devices. Since application version 1.02 (S2), or 1.01 (S2-R), respectively. Prior, profile ID 0x0109 (Smart Energy) was used. www.ubisys.de...
  • Page 11 242 (0xF2) 0xA1E0: Green Power Profile ZigBee Green Power Combined Proxy and Sink The ubisys ZigBee manufacturer ID is 0x10F2. This manufacturer code is used to identify OTA upgrade images, for accessing manufacturer-specific ZCL attributes and commands etc. Installation Code This power switch has a pre-configured link key, which is derived from the installation code printed on the back of the unit’s housing in text format and as a two-dimensional barcode (QR code).
  • Page 12 ZigBee Device Profile (ZDP). Notice that the ZDP is fundamentally different from typical application endpoints, which build on the ZigBee foundation framework and the ZigBee Cluster Library (ZCL). The ubisys ZigBee Power Switch S2/S2-R supports the following ZDO services: Primitive Description...
  • Page 13 The remaining time, in seconds, the device will be identifying itself. Notice that S2 currently does not provide any visual feedback in identify mode. Cluster commands supported: Command Description 0x00 Identify Puts the device into identify mode, or terminates identify mode. www.ubisys.de...
  • Page 14 If true, the scene identified by CurrentGroup and CurrentScene is currently active, i.e. all device attribute values match the values in the scene field set. 0x0004 bitmap8, NameSupport read-only Always set to 1: This implementation does support storing names for scenes. Cluster commands supported: Since application version 1.13 www.ubisys.de...
  • Page 15 0x00 Turn off Turns the output off. The attached load will be disconnected from the mains. Caution: There might still be high voltage at the output if it is freewheeling, because of the finite impedance Since application version 1.13 www.ubisys.de...
  • Page 16 Restores the global scene. Despite the name of this command, it does not always turn the device “on”; rather, it just recalls the previously stored setting. 0x42 On with timed off Turns the output on and then automatically turns it off after the specified time has elapsed. www.ubisys.de...
  • Page 17 The remaining time, in seconds, the device will be identifying itself. Notice that S2 currently does not provide any visual feedback in identify mode. Cluster commands supported: Command Description 0x00 Identify Puts the device into identify mode, or terminates identify mode. www.ubisys.de...
  • Page 18 If true, the scene identified by CurrentGroup and CurrentScene is currently active, i.e. all device attribute values match the values in the scene field set. 0x0004 bitmap8, NameSupport read-only Always set to 1: This implementation does support storing names for scenes. Cluster commands supported: Since application version 1.13 www.ubisys.de...
  • Page 19 Turns the output off, it was turned on or turns the output on, if it was turned off. Caution: Even if toggled off, there might still be high voltage at the output if it is freewheeling, because of Since application version 1.13 www.ubisys.de...
  • Page 20 Restores the global scene. Despite the name of this command, it does not always turn the device “on”; rather, it just recalls the previously stored setting. 0x42 On with timed off Turns the output on and then automatically turns it off after the specified time has elapsed. www.ubisys.de...
  • Page 21 This cluster instance is intended for recalling scenes on the local and/or remote devices using the local inputs and is not bound when factory fresh. Cluster commands transmitted: Command Description 0x05 Recall Scene Recalls a scene. The group address in the recall scene command payload is also used as the target for the command. www.ubisys.de...
  • Page 22 Moves the level either up or down at a specified rate. Maintains the companion on/off cluster’s OnOff attribute. 0x07 Stop with on/off Stops any level change in progress due to a move, move to level, step or recall scene command. Maintains the companion on/off cluster’s OnOff attribute. www.ubisys.de...

  • Page 23: Scenes Cluster (Client)

    This cluster instance is intended for recalling scenes on the local and/or remote devices using the local inputs and is not bound when factory fresh. Cluster commands transmitted: Command Description 0x05 Recall Scene Recalls a scene. The group address in the recall scene command payload is also used as the target for the command. www.ubisys.de...

  • Page 24: On/Off Cluster (Client)

    Moves the level either up or down at a specified rate. Maintains the companion on/off cluster’s OnOff attribute. 0x07 Stop with on/off Stops any level change in progress due to a move, move to level, step or recall scene command. Maintains the companion on/off cluster’s OnOff attribute. www.ubisys.de...

  • Page 25: Application Endpoint #5 - Metering

    Flags indicating current device status. 0x0300 enum8, UnitOfMeasure read-only This is always kW. 0x0400 signed24, InstantaneousDemand read-only, The power currently delivered to the attached load, in Watts. A negative value indicates reportable power generated by the attached device. www.ubisys.de...

  • Page 26: Electrical Measurement Cluster (Server)

    Phase L1: Power factor of the attached load, in 0.01 units. Positive values indicate an inductive load (L), negative values a capacitive load (C), close to zero values a resistive load (R) and close to 1.00 purely capacitive/inductive loads. www.ubisys.de...

  • Page 27: Application Endpoint #232 - Device Management

    The stack version 0x0003 unsigned8, HWVersion read-only Specifies the hardware revision number 0x0004 string, ManufacturerName read-only “ubisys” 0x0005 string, ModelIdentifier read-only “S2 (5502)” or “S2-R (5602)” 0x0006 string, DateCode read-only “YYYYMMDD-XX-FBV”, where YYYY = year, MM = month, DD = day of production (hardware), XX = production facility, V = factory block version.

  • Page 28: Identify Cluster (Client)

    OTA image format to upgrade devices in the field using your own OTA server and back-end. If you operate the power switch S2 together with the ZigBee/Ethernet Gateway ubisys G1, the latest firmware for S2 and S2-R will always be available automatically and you do not need to request it explicitly.
  • Page 29 “raw data” (0x41). This attribute contains instructions, a kind of micro-code, which allow flexible reconfiguration of the commands sent in response to activity on the physical inputs. The array elements take the following form: www.ubisys.de...
  • Page 30 ID and role (client vs. server). ClusterID Specifies the cluster ID that will be used in the outgoing ZCL command frame. The cluster ID must be www.ubisys.de...
  • Page 31 This is the template of a ZCL command frame payload, which will be sent to the target device once the instruction is selected for execution by the universal input logic unique to ubisys ZigBee devices. This can be a simple toggle command, or a more complex move or recall scene command, for example.
  • Page 32 Cluster ID: 0x0006 - on/off ZCL Command Template: Toggle The ubisys Smart Home app for iOS and Android recognizes and generates a certain set of instructions, and lets users pick those easily. You may request an up-to-date list of optimized instructions by mailing support@ubisys.de and asking for these recommended instructions for typical...

  • Page 33: Application Endpoint #242 - Zigbee Green Power

    Allows to disable certain Green Power features on this device 0x0020 bitmap8, gpSharedSecurityKeyType persistent Determines the security key type to use for devices with bidirectional commissioning capabilities, i.e. out-of-the-box individual key, shared GP key, etc. Bidirectional communication is currently limited to the commissioning stage www.ubisys.de...

  • Page 34: Green Power Cluster (Client)

    The S2(-R) can be put in commissioning mode either by using a suitable commissioning tool (for example the ubisys Network Manager) or by instigating Finding & Binding as a target. Once in commissioning mode, the device is ready to pair with Green Power switches. Notice that endpoints #1 and #2 are commissioned individually, i.e.
  • Page 35 Turns the output off Press Button A Turns the output on Press Button B Turns the output off Press Button C Toggles the output, i.e. turns it on when it is off, and turns it off when it is on www.ubisys.de...
  • Page 36 Tunnels GP data frames from a sink to a bidirectional Green Power Device 0x0B GP Proxy Table Request Allows to query the proxy table for a certain Green Power Device or read out the table in chunks Cluster commands transmitted: Bidirectional communication is currently limited to the commissioning stage www.ubisys.de...
  • Page 37 Tunnels GP frames from a Green Power Device to one or more sinks or groups of sinks 0x04 GP Commissioning Notification Tunnels GP frames from a Green Power Device to a sink in commissioning mode 0x0B GP Proxy Table Response Conveys a set of proxy table entries to a sink or management application www.ubisys.de...

  • Page 38: Physical Dimensions

    Figure 1: Flush-mount In-wall ZigBee Dual Power Switch S2 – Dimensions (1 TE) 18 mm 60,5 mm Leistungs- schalter S2-R Funkvernetzt mit Stromverbrauchs- messung 230 V~/50 Hz 2 x 500 VA Figure 2: Rail-mount ZigBee Dual Power Switch S2-R – Dimensions www.ubisys.de...

  • Page 39: Ordering Information

    ORDERING INFORMATION The following tables list the product variants available. Use the specified order code for your orders. Please contact ubisys support if you require any customization. Order Code Description 1069 ZigBee Dual Power Switch S2 (in-wall, flush-mount) 1168 ZigBee Dual Power Switch S2-R (rail mount) The housing is flame retardant (V-0), Color: Black, RAL 9005.

  • Page 40: General Terms & Conditions Of Business

    10. GENERAL TERMS & CONDITIONS OF BUSINESS When placing your order you agree to be bound by our General Terms & Conditions of Business, “Allgemeine Geschäftsbedingungen”, which are available for download here: http://www.ubisys.de/en/smarthome/terms.html www.ubisys.de...

  • Page 41: Declaration Of Conformity

    We – ubisys technologies GmbH, Neumannstraße 10, 40235 Düsseldorf, Germany – declare under our sole responsibility that the ubisys ZigBee Dual Power Switches S2 and S2-R with order codes as detailed in section 9 under the trade name “ubisys” to which this declaration relates are in conformity...

  • Page 42: Revision History

    1.08. Corrected description of element data type for switch configuration (should have been 0x41 instead of 0x48). 04/18/2018 Added missing information about Green Power sink behaviour, i.e. supported Green Power device types and commands 09/16/2021 Update Declaration of Conformity www.ubisys.de...

  • Page 43: Contact

    13. CONTACT UBISYS TECHNOLOGIES GMBH NEUMANNSTRASSE 10 40235 DÜSSELDORF GERMANY T: +49 (211) 54 21 55 - 00 F: +49 (211) 54 21 55 - 99 www.ubisys.de info@ubisys.de www.ubisys.de...

Table of Contents