ubisys H1 Zigbee Heating Regulator Instruction Manual

H1 Zigbee Heating Regulator

“`html

Specifications

• 64KB SRAM

• IEEE 802.15.4 compliant PHY and real-time MAC

• Primary Channels: 11, 15, 20, 25

• Secondary Channels: 12, 13, 14, 16, 17, 18, 19, 21, 22, 23, 24,
  26

• Global Default Trust Center Link-Key (ZigBeeAlliance09)

• ZigBee 3.0 Global Distributed Security Link-Key

• Device-individual link-key derived from installation code –
  also printed as QR barcode

Product Usage Instructions

Installation

Please refer to the installation guide included in the product
package for detailed instructions.

Initial Device Start-Up

Follow the start-up instructions provided in the manual to
initialize the device.

Man-Machine Interface (MMI)

The H1 features a user-friendly MMI for easy interaction.

Appearance of H1

Display of H1

Commissioning and Operations on H1

Utilize the buttons and rotary dial as shown in Figure 1 for
commissioning and operational tasks.

The display provides information on the progress of tasks,
temperature set-point, and current operational status related to
heating regulation.

Supported Commissioning and Operational Tasks on H1 via

MMI

tappet to the radiator valve
2-6| Zigbee Commissioning: Factory Reset, Network Steering, Finding
& Binding, Unmount, Set Date & Time, Configure Weekly
Schedule

FAQ

Q: How do I trigger a calibration process on the H1?

A: To trigger a calibration process, navigate to the calibration
option in the MMI and follow the on-screen instructions.

Q: Can I manually set the date and time on the H1?

A: Yes, you can manually set the date and time by accessing the
appropriate settings in the MMI.

Q: How can I reset all settings to factory defaults on the

H1?

A: To reset to factory defaults, go to the Factory Reset option
in the MMI and confirm the reset.

“`

ZIGBEE HEATING REGULATOR H1 REFERENCE MANUAL

Table of Contents
1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2. Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 3. Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 4. Initial Device Start-Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 5. Man-Machine interface (MMI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5.1. Appearance of H1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 5.2. Display of H1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 5.3. Commissioning and operations on H1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 6. Zigbee Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 6.1. Device Anatomy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 6.2. Installation Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 6.3. Application Endpoint #0 – Zigbee Device Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 6.4. Application Endpoint #1 – Thermostat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
6.4.1. Basic Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 6.4.2. Power configuration Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 6.4.3. Identify Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 6.4.4. Groups Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 6.4.5. Scenes Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 6.4.6. Time Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 6.4.7. Poll Control Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 6.4.8. Thermostat Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 6.4.9. Works With All Hubs Cluster (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 6.4.10. Identify Cluster (Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 6.4.11. Time Cluster (Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 6.4.12. Over-the-Air Upgrade Cluster (Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 6.4.13. Thermostat Cluster (Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 6.4.14. Temperature Measurement (Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 6.4.15. Relative Humidity Measurement (Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 6.4.16. Occupancy Sensing (Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 7. Thermostat Heating Setpoints Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 7.1. Weekdays configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 7.2. Format of setpoint schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 7.3. Number of daily heating setpoint schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 7.4. Schedule Configuration Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 8. Physical Dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 9. Ordering Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 10. General Terms & Conditions Of Business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 11. Declaration Of Conformity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 12. Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 13. Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

1. Overview
Thank you for purchasing the ubisys Heating Control H1. The H1 heating control is a smart, batterypowered radiator thermostat with integrated temperature sensor for radiator heating systems and is used for efficient room temperature control in private and commercial facilities. 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. An installation guide specific to your region is available as a separate document and is included in printed form in the product package. If you have any questions or need additional support, please visit the support pages that best fit your background: If you are a consumer (private household) or installer, please visit the Smart Home support pages at http://www.ubisys.de/en/smarthome/support.html for contact details. As a commercial customer, please visit the Engineering support pages at https://www.ubisys.de/en/business-customers/ for contact details.
Copyright© 2020-2024 ubisys technologies GmbH, Düsseldorf, Germany. All rights reserved.
1

2. Features
· Advanced Zigbee 3.0 radiator controller · Advanced PI control loop to determine optimum heating demand · Supports scheduling heating set-points on a weekly basis · Supports vacation mode with configurable heating set-point schedule · Works with remote temperature, occupancy or combined environmental sensors · Supports automatic adjustment of local time based on time zone, daylight saving time and other
data retrieved from a time server
· Supports open window detection, which senses room temperature changes and automatically adapts its heating behavior to conserve energy
· Supports constraining the range of valve opening position within the designated operational area to prevent potential cavitation noise
· Supports automatic entry into backup mode and adjusts the open valve position accordingly, applying different presets for backup heating demands during summer and winter seasons. This functionality is triggered by factors such as insufficient battery power.
· Local control even works when the device is not joined to a network (not commissioned yet) · Offers a clear and responsive Man-Machine-Interface (MMI): Display, push-button and rotary dial
for calibration, network commissioning, temperature set-point setup, weekly schedule configuration, set vacation mode, prompt to replace batteries, enable/disable open window detection mode etc.
· Made in Germany using high-quality, enduring parts for many years of life expectancy · Supports groups, scenes, bindings, and reporting · On-board MCU: Advanced 32-bit Qorvo QPG6095 micro-controller running at 32MHz with
64KB SRAM, featuring IEEE 802.15.4 compliant PHY and real-time MAC
· On-board inverted-F antenna · Leverages ubisys 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 }; Secondary = { 12, 13, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26 }
· Supports joining centralized and distributed security networks as sleepy end device · Three pre-configured Trust Center Link-Keys for joining:
Global Default Trust Center Link-Key (“ZigBeeAlliance09”)
ZigBee 3.0 Global Distributed Security Link-Key
Device-individual link-key derived from installation code – also printed as QR barcode
· Extended APS duplicate rejection table with up to 64 slots – 64 times the capacity required by the standard (1)
· Extensive transmit and receive queues for optimum through-put and minimum packet drop rate · Reliable packet transmission with automatic network-level retries · Advanced initial joining algorithm featuring a fast retry mode and options for back-off · Advanced rejoining algorithm featuring a fast retry mode and options for back-off
2

· Enhanced retry mechanism to increase the reliability of data polling · Feature support of the Amazon Works With All Hubs (WWAH) cluster · Firmware upgradable over-the-air during normal operation using ZigBee OTA Upgrade Cluster
3

3. Installation
Please refer to the installation guide of the product manual, which is included in the product package. It provides detailed installation instructions.
4

4. Initial Device Start-Up
In a factory-new state, the H1 looks for open ZigBee networks to join when being first-time supplied with power. Open your ZigBee network for joining and then power-up the H1. After the initialization phase, the H1 starts the calibration process, during which movements of the H1 valve pin take place to adjust to the radiator valve. Following a successful calibration, H1 performs the network startup, discovers existing networks and attempts to commission itself to an open Zigbee network. After initial network commissioning to an open network succeeds, the quality of the Zigbee wireless connection is indicated in the upper left corner of H1’s display. the H1 will then prolong the joining window by three minutes by broadcasting a ZDO permit joining request command. After reboot, given the H1 has been properly commissioned before, it attempts resuming network activity by performing network rejoin to find a suitable router parent. Once completed, H1 will broadcast a device announcement command to announce itself to the entire network. In such a rejoin case, H1 will NOT broadcast a ZDO permit joining request command to start a new joining window.
5

5. Man-Machine interface (MMI)
The application software installed on the H1 provides a user-friendly MMI.
5.1. Appearance of H1

Figure 1. Heating Regulator H1 – Appearance of the device
5.2. Display of H1

Figure 2. Heating Regulator H1 – Display of the device

5.3. Commissioning and operations on H1

Utilizing button press and rotary dial as shown in Figure 1, user can swiftly and effortlessly complete commissioning and operational tasks on the H1. The display succinctly showcases the progress and outcomes of a commissioning process, along with the temperature set-point and current operational status related to heating regulation, see e.g. Figure 2

Table 1. Supported commissioning and operational tasks on H1 via MMI

Item # 1

Commissioning and Operational Tasks
Operation: Calibration Trigger a calibration process to automatically match the H1’s tappet to the radiator valve

6

Item # 2 3 4 5 6
7
8

Commissioning and Operational Tasks
Zigbee Commissioning: Factory Reset Resets all settings to factory defaults and restarts the device
Zigbee Commissioning: Network Steering Option #1: Attempt to join an open network, if H1 is in a factory-new state Option #2: Broadcast a ZDO Permit Joining command to open a network for 180 seconds, if H1 is operational on this network
Zigbee Commissioning: Finding & Binding Option #1: As F&B Initiator, query identifying targets and create suitable bindings to the discovered targets Option #2: As F&B Target, enter the identify mode for 180 seconds
Operation: Unmount Retract the H1’s ram completely for facilitating a convenient disassembly
Operation: Set Date & Time Manually set the current date and time for enabling configuration of weekly schedules on the H1. Should a device in the same network operate as a timer server (e.g. the ubisys Gateway G1), furnishing time information, H1 can autonomously request this information, obtaining wirelessly and syncing its local time accordingly.
Operation: Set Temperature Offset In specific situations, the temperature measured locally on H1 may differ from the overall temperature at the location. To address this, user can manually set an optional temperature offset within the range of [-10°C, +10°C]. This offset compensates for any discrepancies, meaning that the temperature used for regulation is calculated as the locally measured temperature minus the temperature offset. Note that if a remotely measured temperature value is obtained through over-the-air reporting, it will be directly used for heating regulation without taking the temperature offset into account.
Operation: Configure Weekly Schedule Create automated heating regulation based on pre-configured weekly set-point schedules.

Note that, weekly schedules can be added, modified or removed not only through the MMI on the H1, but also upon receiving over-the-air ZCL commands from a management system.

If setting or adding weekly schedules through the MMI, keep in mind that the internally applied schedule transition pattern may differ from the one defined in an over-the-air ZCL Set Weekly Schedule command. Upon reception of such a command, the existing MMI-added weekly schedules will be entirely erased before storing the newly received schedules using the standard ZCL pattern. Furthermore, the MMI for weekly schedule configuration will stay disabled until the schedules using the standard ZCL pattern are later removed totally.

Please find the details at Chapter 7

9

Operation: Switch Off

Switch off H1 and stop heating regulation.

10

Operation: Enable Vacation Mode

Apply heating schedules for the vocation mode, if any, or the pre-defined temperature set-point for absence.

For carrying out each specific commissioning and operational tasks listed above Table 1 on H1, please refer to the Heating Control H1 – Manual, which provides detailed instructions respectively.

7

6. Zigbee Interface
Please refer to the following IEEE and ZigBee Alliance documents, which apply to this product:
[R1] IEEE Standard 802 – Part 15.4: Low-Rate Wireless Personal Area Networks (LR-WPANs) [R2] ZigBee Specification, Revision 22, Document No. 05-3474-22 [R3] ZigBee 2015 Layer PICS and Stack Profiles, Revision 6, Document No. 08-0006-06 [R4] ZigBee Cluster Library Specification, Revision 8, Document No. 07-5123-08 [R5] ZigBee Base Device Behavior Specification, Revision 12, Document No. 16-02828-12 [R6] ZigBee PRO Green Power Feature Specification, Revision 26, Document No. 09-5499-26 [R7] ZigBee Home Automation Public Application Profile 1.2, Revision 29, Document No. 05-352029 [R8] ZigBee Smart Energy Standard 1.1b, Revision 18, Document No. 07-5356-18 [R9] ZigBee WWAH ZCL Cluster Definition, Version 1., Document No. 17-01067-024

6.1. Device Anatomy

The H1 heating control, a battery-powered smart radiator thermostat with a built-in temperature sensor designed for radiator heating systems, ensures precise and effective temperature regulation in both residential and commercial spaces.

Using Zigbee, a globally recognized radio standard, the H1 communicates wirelessly. Temperature control is fully automated, with the ability to set the temperature either through predefined weekly schedules or manually on the H1 itself. Remote adjustments can also be made via a smartphone application, such as the ubisys Smart Home App.

To operate through the ubisys Smart Home App, the ubisys Gateway G1 is necessary. If a Zigbeecapable gateway from another manufacturer is employed, an appropriate app can be utilized. The power source of the H1 consists of two lithium batteries (type AA with 1.5 V, Energizer L91, Ultimate Lithium, or an equivalent).

H1 provides 2 Zigbee application endpoints:

Endpoint # 0 (0x00)
1 (0x01)

Profile
0x0000: Zigbee Device Profile
0x0104: Common Profile (HA)

Application Zigbee Device Object (ZDO) ­ standard management features
Thermostat (0x0301). This endpoint enables temperature regulation and valve output control, aligning with either individual temperature set-points or weekly schedules. It also supports group and scene functionalities. The identify cluster facilitates Finding & Binding commissioning, serving as either initiator or target. Moreover, the thermostat client allows remote control through another thermostat, while the time client, the temperature sensor client or the occupancy client facilitate the reception of measurement values from a remote entity for local control purposes.

6.2. Installation Code
The Zigbee heating controller H1 comes with a preset link key that is generated from a unique installation code. The label, on which this code is printed as a two-dimensional barcode (QR code), can be found on the inner surface of the housing, after removing the rotary dial of the device H1. The format specified in [R6], section 5.4.8.1.1, is used with a full 128-bit installation code + 16-bit CRC. The QR code contains additional information as illustrated in the following example:

Z:001FEE000000998B$I:D4A2486AC24F9723A5C639B26916D505B189%G$M:H1%M:10F2

8

The content string initiates with an EUI-64 address (prefixed by “Z:”). It is followed by a complete 128-bit installation code along with its 16-bit CRC checksum (prefixed by “I:”). Following that are the model identifier string “H1” (prefixed by “M:”) and the manufacturer code 0x10f2 (prefixed by “M:”).

6.3. Application Endpoint #0 – Zigbee Device Object

Please refer to the ZigBee Specification [R2] for details on the ZigBee Device Object (ZDO) and the protocol used for over-the-air communication, called the 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 H1 supports the following ZDO services:

Primitive

Description

nwk_addr_req/ nwk_addr_rsp

Network address request/response Translates a 64-bit IEEE address into a 16-bit network short address. Use only when really required, because this message employs a network-wide broadcast (flooding)

ieee_addr_req/ ieee_addr_rsp

IEEE address request/response Translates a 16-bit network short address into a 64-bit IEEE address.

node_desc_req/ node_desc_rsp

Node descriptor request/response Returns information such as the manufacturer ID, power supply, etc.

power_desc_req/ Power descriptor request/response power_desc_rsp [1] Returns information such as the power source and mode.

active_ep_req/ active_ep_rsp

Active endpoints request/response Returns a set of available application endpoints on the device.

simple_desc_req/ simple_desc_rsp

Simple descriptor request/response Returns a descriptor for a certain application endpoint with a list of available services (clusters).

match_desc_req/ match_desc_rsp
device_annce

Match descriptor request/response Searches for a certain cluster or set of clusters and returns the matching endpoints, if any.
Device announcement Advertises the presence of a new device in the network.

parent_annce/

Parent announcement/response

parent_annce_rsp [2] This is part of the Zigbee 2015 end-device child management feature.

bind_req/ bind_rsp

Bind request/response Creates an application binding

unbind_req/ unbind_rsp

Unbind request/response Removes an application binding

mgmt_nwk_disc_req/ Management: Network discovery request/response mgmt_nwk_disc_rsp [3 Instructs the device to perform a network discovery and report the results back.
]

mgmt_lqi_req/ mgmt_lqi_rsp

Management: Neighbor table request/response Returns information about neighboring devices, including the link quality, device type etc.

mgmt_rtg_req/ mgmt_rtg_rsp

Management: Routing table request/response Returns information about routes established on the device.

mgmt_bind_req/ mgmt_bind_rsp

Management: Binding table request/response Returns information about application bindings on the device.

mgmt_leave_req/ mgmt_leave_rsp

Management: Leave request/response Makes the device leave the network or removes one of its end-device children.

mgmt_permit_joining _req/ mgmt_permit_joining _rsp

Management: Permit joining request/response Opens the network for new devices to join.

mgmt_nwk_update _req/ mgmt_nwk_update _notify[3]

Management: Network update request/response/notification Performs energy scans, instigates a channel change or assigns the network manager.

9

6.4. Application Endpoint #1 – Thermostat

Use this application endpoint to control the heating unit connected to output.

This is a Finding & Binding initiator endpoint.

The application endpoint exposes the following clusters:

Cluster 0x0000 0x0001 0x0003 0x0004 0x0005 0x000a 0x0020
0x0201
0xfc57
0x0003 0x000a 0x0019
0x0201 0x0402 0x0405

Direction Inbound (Server)
Inbound (Server)
Inbound (Server)
Inbound (Server)
Inbound (Server)
Inbound (Server) Inbound (Server)
Inbound (Server)
Inbound (Server)
Outbound (Client) Outbound (Client)
Outbound (Client)
Outbound (Client) Outbound (Client) Outbound (Client)

Description
Basic Provides basic information about the device, such as the manufacturer ID, vendor and model name, stack profile, ZCL version, production date, hardware revision etc. Allows a factory reset of attributes, without the device leaving the network.
Power Configuration Allows to obtain the detailed information about the device’s power source and configure under/over voltage alarms.
Identify Allows to put the endpoint into identify mode. Useful for identifying/locating devices and required for Finding & Binding.
Groups Allows adding this endpoint to one or more groups. Afterwards the endpoint can be addressed using the group address. This is also a prerequisite for scenes. You may also query group membership and delete group associations.
Scenes Allows storing one or more scenes per group, where each scene consists of a pre-set on/off state value. You may either store the current values as a scene, or provide scene settings when adding a scene, or delete scenes.
Time Expose the internal time information.
Poll Control Provides a mechanism to handle the MAC Data Request rate when functioning as a sleepy end device. The server side encompasses various attributes related to the MAC Data Request rate for the end device. At pre- defined intervals, it sends a check-in query to the client to determine if the client wishes to switch to the fast polling mode for responsive data transaction.
Thermostat Provides an interface to the functionality of a thermostat. Allow to obtain basic information like local temperature, Occupancy, HeatingDemand, Heating Set point etc. Allow to configure the device’s behavior depending on the specified operating environment and the system mode etc. Allow to configure the device’s behavior according to the specified weekly schedules.
Works With All Hubs This is a manufacturer-specific cluster with the manufacturer code 0x1217. It provides the proprietary functionality of the Amazon Works With All Hubs (WWAH) server cluster. The goal of this cluster is to enable hubs to provide improved security, interoperability, and customer experience for devices supporting this cluster [R9].
Identify Allows to identify targets during Finding & Binding commissioning
Time Synchronizes the internal real-time clock with a Zigbee time server in the network, especially one linked and synchronized with an internet time server.
OTA Provides a standard way to upgrade devices in the network via OTA messages. Pull-oriented firmware upgrade. Searches the network for mating servers and allows the server to control all stages of the upgrade process, including which image to download, when to download, at what rate and when to install the downloaded image.
Thermostat Receives attribute reports from other thermostat servers.
Temperature Measurement Receives attribute reports from other temperature sensors.
Relative Humidity Measurement Receives attribute reports from other humidity sensors.

10

Cluster 0x0406

Direction
Outbound (Client)

Description
Occupancy Sensing Receives attribute reports from other occupancy sensors.

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.

6.4.1. Basic Cluster (Server)
The basic cluster might be accessible via more than one endpoint. Most of its attributes are singleton attributes, i.e. all instances of the cluster share the same attribute value storage.

Attributes supported:

Attribute 0x0000 0x0001 0x0002 0x0003 0x0004 0x0005 0x0006
0x0007 0x0008 0x0009 0x000a 0x000b
0x0010 0x0011 0x4000 0xFFFD

Type unsigned8, read-only unsigned8, read-only unsigned8, read-only unsigned8, read-only string, read-only string, read-only string, read-only
enum8, read-only enum8, read-only enum8, read-only octstr, read-only string, read-only
string, persistent enum8, persistent enum8, read-only unsigned16

Description
ZCLVersion The version of the cluster library
ApplicationVersion The application version
StackVersion The stack version
HWVersion Specifies the hardware revision number
ManufacturerName “ubisys”
ModelIdentifier “H1”
DateCode “YYYYMMDD-XX-FBV”, where YYYY = year, MM = month, DD = day of production (hardware), XX = production facility, V = factory block version. For example, “20220921-DE-FB1” refers to a device built September 21, 2022 in Germany and programmed with factory block format version 1.
PowerSource Always set to be battery-powered.
GenericDevice-Class “Unspecified” by default. Might be set by commissioning software during installation
GenericDevice-Type “Unspecified” by default. Might be set by commissioning software during installation
ProductCode Specifies a code for the product.
ProductURL Specifies a link to a web page containing specific product information. “www.ubisys.de/products/h1”
LocationDescription Empty string by default. Might be set by commissioning software during installation
PhysicalEnvironment “Unspecified” by default. Might be set by commissioning software during installation
SWBuildID Represents a detailed, manufacturer-specific reference to the version of installed software.
ClusterRevision The version of the cluster specification that this implementation adheres to.

Cluster commands supported:

None

11

6.4.2. Power configuration Cluster (Server) The cluster specifies detailed information about H1’s power source.

Attributes supported:

Attribute 0x0020 0x0021 0x0031 0x0033 0x0034 0xFFFD

Type unsigned8 read-only, reportable unsigned8 read-only, reportable enum8 persistent
unsigned8 read-only
unsigned8 persistent
unsigned16

Description
BatteryVoltage Specifies the current measured battery voltage, in units of 100mV.
BatteryPercentageRemaining Specifies the remaining battery life as a half integer percentage of the full battery capacity with a range between 0% and 100%.
BatterySize Specifies the type of battery being used by H1. “AA”
BatteryQuantity Specifies the number of battery cells used to power the device H1. “2”
BatteryRatedVoltage Specifies the rated voltage of the battery being used in H1, measured in units of 100mV. “1.5V”
ClusterRevision The version of the cluster specification that this implementation adheres to.

Cluster commands supported:

None

6.4.3. Identify Cluster (Server)
This endpoint can be applied either as a Finding & Binding target or an initiator according to different applicable scenarios.

Attributes supported:

Attribute 0x0000
0xFFFD

Type unsigned16
unsigned16

Description
IdentifyTime The remaining time, in seconds, the device will be identifying itself.
ClusterRevision The version of the cluster specification that this implementation adheres to.

Cluster commands supported:

Command 0x00
0x01

Description
Identify Allows accepting the command and put the device H1 into identify mode or terminates identify mode.
Query Identify Determines whether the device is currently identifying, and returns the remaining time if so.

In the identify mode, the symbol as a F&B target will flash on the H1’s display for the specified identify duration.

6.4.4. Groups Cluster (Server) Attributes supported:

12

Attribute 0x0000
0xFFFD

Type
Bitmap8, read-only unsigned16

Description
NameSupport Always set to 0, this implementation does not support storing names for groups.
ClusterRevision The version of the cluster specification that this implementation adheres to.

Cluster commands supported:

Command 0x00 0x01 0x02 0x03 0x04 0x05

Description
Add Group Adds the endpoint to a group.
View Group Determines whether the device belongs to a group and returns the group name, if supported.
Get Group Membership Returns the set of groups this endpoint belongs to.
Remove Group Removes this endpoint from the specified group. Also removes all scenes that refer to this group.
Remove All Groups Removes this endpoint from all groups. Also removes all scenes that refer to any of the existing groups.
Add Group if Identifying Adds this endpoint to the group, if the endpoint is identifying.

6.4.5. Scenes Cluster (Server) Attributes supported:

Attribute 0x0000 0x0001
0x0002
0x0003
0x0004 0xFFFD

Type unsigned8, read-only unsigned8, read-only
unsigned8, read-only
bool, read-only
Bitmap8, read-only unsigned16

Description
SceneCount Holds the total number of scenes (across all groups) currently stored on the device.
CurrentScene If the SceneValid attribute is true, this attribute, together with the CurrentGroup attribute, indicates the currently active scene.
CurrentGroup If the SceneValid attribute is true, this attribute, together with the CurrentScene attribute, indicates the currently active scene.
SceneValid 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.
NameSupport Always set to 1: This implementation does support storing names for scenes.
ClusterRevision The version of the cluster specification that this implementation adheres to.

Cluster commands supported:

Command 0x00 0x01 0x02 0x03 0x04 0x05

Description
Add Scene Adds a scene with or without a scene field set
View Scene Returns the scene field set, name and transition times for a scene.
Remove Scene Removes a scene from the scene table.
Remove All Scenes Removes all scenes that belong to a particular group.
Store Scene Stores the device’s current state as a scene or updates a previously stored scene accordingly.
Recall Scene Reverts the device’s current state using the values from the previously stored field set.

13

Command 0x06 0x40 0x41 0x42

Description
Get Scene Membership Returns the set of scenes (within the scope of the specified group) currently stored on the device.
Enhanced Add Scene Similar to Add Scene with higher transition time resolution (10ths of a second instead of once second)
Enhanced View Scene Similar to View Scene with higher transition time resolution (10ths of a second instead of once second)
Copy Scene Copies a scene in a single operation as an alternative to (Enhanced) View Scene, (Enhanced) Add Scene

6.4.6. Time Cluster (Server) Expose the internal time information.

Attributes supported:

Attribute 0x0000
0x0001 0xFFFD

Type UTC global-scope
Bitmap8, global-scope unsigned16

Description
Time Holds the time value of a real-time clock, in UTC time format. It may not be synchronized to UTC, indicated by the value of the TimeStatus attribute.
TimeStatus As bitmap attribute indicating the status of the Time attribute.
ClusterRevision The version of the cluster specification that this implementation adheres to.

Cluster commands supported:

None

6.4.7. Poll Control Cluster (Server) Attributes supported:

Attribute 0x0000 0x0001 0x0002
0x0003 0x0004 0x0005 0x0006 0xFFFD

Type Unsigned32 persistent
Unsigned32 read-only
Unsigned16 read-only
Unsigned16 persistent
Unsigned32 read-only
Unsigned32 read-only
Unsigned16, read-only
unsigned16

Description
Check-inInterval Specifies the amount of time between check-ins by the server with a remote poll control client, measured in quarterseconds.
LongPollInterval Specifies the maximum amount of time in quarterseconds between MAC Data Requests from the local end device to its router parent.
ShortPollInterval Specifies the amount of time in quarterseconds that the local end device waits between sending MAC Data Requests to its router parent when the local end device is expecting data transaction (i.e., in fast poll mode).
FastPollTimeout Specifies the amount of time in quarterseconds that the local end device will stay in fast poll mode by default.
Check-inIntervalMin Specifies the minimum value for the check-in interval to protect against the check-in interval being set too low and draining the battery of the local end device.
LongPollIntervalMin Specifies the minimum value for the long-poll interval to protect against another device setting the value to a too short value resulting in an inadvertent power drain on the local end device.
FastPollTimeoutMax Specifies the maximum value for the fast-poll timeout to avoid it being set to a too high value resulting in an inadvertent power drain on the local end device.
ClusterRevision The version of the cluster specification that this implementation adheres to.

14

Cluster commands supported:

Command 0x00
0x01 0x02 0x03

Description
Check-in Sends out this command to find out if Poll Control cluster clients, with which it is paired, are interested in having it entering fast polling mode so that the local end device becomes responsive for pending data transactions.
Fast Poll Stop Receives this command from a paired client and stops the fast poll mode initiated before.
Set Long Poll Interval Receives this command from a paired client to set the read-only long-poll interval accordingly, if acceptable.
Set Short Poll Interval Receives this Command from a paired client to set the read-only short-poll interval accordingly, if acceptable.

6.4.8. Thermostat Cluster (Server)

This cluster uses the binding table for managing reporting targets.

Attributes supported:

Attribute 0x0000 0x0001 0x0002 0x0003

Type
Signed16, read-only, reportable
Signed16, read-only, reportable
Bool, read-only, reportable
Signed16, read-only

0x0004 0x0008
0x0012 0x0014 0x001b

Signed16, read-only
Unsigned8, read-only, reportable
Signed16, reportable
Signed16, reportable
enum8, reportable

0x001c

enum8, reportable

0x001e 0x0020

enum8, reportable
enum8, read-only

0x0021

Unsigned8, read-only

Description
LocalTemperature Indicates the locally or remotely (over the network) measured temperature value in the heating zone.
OutdoorTemperature Indicates the outdoor temperature value in the heating zone. This might be measured using remote zigbee temperature or environmental
Occupancy Determines whether the heated space is occupied or not, as measured locally or remotely (over the network).
AbsoluteMinimumHeatingSetpoint Indicates the lowest permissible value for the occupied and unoccupied heating setpoints. In antifreeze mode, this is also the value being used to control the temperature.
AbsoluteMaximumHeatingSetpoint Indicates the highest permissible value for the occupied and unoccupied heating setpoints.
PIHeatingDemand Quantifies the amount of heating required from a heating device in order to reach the active heating setpoint, as determined by the PI control loop. This is a steering value in the range 0…100%.
OccupiedHeatingSetpoint Specifies the heating mode setpoint when the room is occupied.
UnoccupiedHeatingSetpoint Specifies the heating mode setpoint when the room is unoccupied.
ControlSequenceOfOperation Specifies the overall operating environment of H1, and thus the possible system modes that H1 can operate in. H1 supports “Heating Only” option.
SystemMode Specifies the current operating mode of the thermostat. H1 supports “Off”, “Auto” and “Heat” the three options. “Heat” by default
RunningMode Represents the running mode of H1, i.e. the actual mode it is currently in. H1 supports “Off” and “Heat” the two options.
StartOfWeek Specifies the day of the week that H1 considers to be the start of week for weekly set point scheduling. “Monday”
NumberOfWeeklyTransitions Specifies the number of weekly schedule transitions H1 is capable of handling. “70”

15

Attribute 0x0022
0xFFFD

Type Unsigned8, read-only
unsigned16

Description
NumberOfDailyTransitions Specifies the number of daily schedule transitions H1 is capable of handling. “10”
ClusterRevision The version of the cluster specification that this implementation adheres to.

Manufacturer-specific attributes supported:

Attribute 0x0010 0x0011 0x0012 0x0013 0x0014 0x0015 0x0016
0x0017 0x0018 0x0019 0x001A

Type Signed8, persistent
Signed16, persistent Boolean, persistent Signed16, read-only
Unsigned16, persistent Bitmap8, persistent Bitmap8, read-only
Unsigned16, persistent
Unsigned16, persistent
Unsigned16, persistent
Unsigned8, persistent

Description
TemperatureOffset [4] Specifies the temperature offset for the locally measured temperature value. This is to account for situations where the H1 is mounted in a place with little to no air flow and as a consequence the heat stowing.
DefaultOccupiedHeatingSetpoint [5] Specifies the default heating setpoint during occupancy, representing the targeted temperature when a recurring weekly schedule ends without a follow-up schedule.
VacationMode [6] [7] Indicates whether vocation mode is activated. If active, the corresponding vocation schedule, if defined, should be applied.
RemoteTemperature [8] Indicates the remotely measured temperature value, accessible through attribute reports. For heating regulation, a received remote temperature value, as long as valid, takes precedence over the locally measured one.
RemoteTemperatureValidDuration [8] Specifies the duration period in seconds, during which a remotely measured temperature value remains valid since its reception as attribute report.
DetectOpenWindow [9] Specifies whether the Open Window Detection is activated or deactivated. The work mode is disabled by default.
OpenWindowState [9] Presents the currently detected window state, if the Open Window Detection is activated: “1”: an open window is detected “0”: a closed window is detected
Once an open window is detected, a predefined anti-freeze heating setpoint e.g. 7°C is applied to the heating unit. If a closed window is detected, the default setpoint settings are applied. These could either be the default (un)occupied heating setpoints or an active heating setpoint specified through a thermostat schedule, if available.
OpenWindowSensitivity [9] Specifies the temperature change threshold for the Open Window Detection. This is the point at which the H1 detects a significant temperature change indicating the detection of an open or closed window. “1.5°C” (150) by default.
OpenWindowDetectionPeriod [9] Specifies the time duration in minutes, within which the sharp temperature change must have taken place for the open window detection. “5” minutes by default.
OpenWindowTimeout [9] Specifies the maximum time duration in seconds for a detected open-window state. This attribute effectively defines how long a detected open-window state should last before H1 returns back to its default set point settings. “1800” (30min) by default.
HeatingDemandLowerBound [10] Imposes a lower bound on the steering level of the heating valve, in percentage. Any steering levels falling below this threshold, with the exception of 0, will be clamped to the specified value. If left undefined, indicated by 0xFF, no clamping occurs. “0xFF” by default.

16

Attribute 0x001B 0x001C
0x001D 0x001E 0x0020 0x0021 0x0022

Type Unsigned8, persistent
Enum8, persistent
Unsigned8, persistent
Unsigned8, persistent
Signed16, persistent Signed8, persistent Signed16, persistent

Description
HeatingDemandUpperBound [10] Imposes an upper bound on the steering level of the heating valve, in percentage. Any steering levels exceeding this threshold will be clamped to the specified value. If left undefined, indicated by 0xFF, no clamping occurs. “0xFF” by default.
Season [11] Indicates whether the device is operating in winter or summer mode, which impacts steering the open valve position through applying different heating demand backup presets during backup mode. A value of ‘0’ signifies the winter mode, where primary heating demand backup values are applied. Conversely, a value of ‘1’ denotes the summer mode, where alternate heating demand backup values are applied. “0” by default.
BackupHeatingDemand [11] Specify the primary heating demand backup value (in percentages) for winter conditions in the event that the device is switched to the winter backup mode, triggered by factors such as insufficient battery power. “25%” by default.
AlternateBackupHeatingDemand [11] Specify the alternative heating demand backup value (in percentages) for summer conditions in the event that the device is switched to the summer backup mode, triggered by factors such as insufficient battery power. “0%” by default.
ProportionalGain [12] Specifies the proportional gain (Kp) of the applied PI controller on H1
ProportionalShift [13] Specifies the proportional down-scaling term, noted as shift value (N), of the applied PI controller on H1
IntegralFactor [14] Specifies the integral factor of the applied PI controller on H1

Cluster commands supported:

Command 0x00
0x01

Description
Setpoint Raise/Lower Receives this command from a client to increase or decrease the indicated setpoint(s) with the specified amount, in steps of 0.1°C.
Set Weekly Schedule Receives this command from a client to update its weekly set-points schedule. The weekly schedule of set-points, stored in the H1, becomes effective upon its reception.

0x02 0x03

– Receiving this command, the H1 is enabled to create a new schedule if none available, add a new schedule to the existing ones or modify the existing ones on the associated days. – Setting the field NumberOfTransitionsForSequence in the header to be 0, the H1 is enabled to delete the existing schedules on the associated days. – The H1 does not support receiving multiple Set Weekly Schedule commands if the field NumberOfTransitionsForSequence is set to be more than 10.
Get Weekly Schedule Receives this command from a client to provide the existing weekly set-point schedule that conforms to the requested mode and days.
Clear Weekly Schedule Receives this command from a client to clear all existing weekly schedules currently stored in the H1.

6.4.9. Works With All Hubs Cluster (Server)
Works With All Hubs cluster is a manufacturer-specific cluster from Amazon, identifiable through the cluster ID 0xfc57 and manufacturer ID 0x1217 and can exist at most only once on each device node [R9]. This cluster provides an interface for enabling various features of the Works With All Hubs cluster on H1.

17

Manufacturer-specific attributes supported:

Attribute 0x0002 0x0003 0x0004 0x0005 0x0006 0x0007 0x0008 0x0009 0x000A 0x000B 0x000C 0x000D 0x000E 0x000F 0x0010 0x0011 0x0012

Type Boolean, read-only, persistent Boolean, read-only, persistent Unsigned8, read-only
Unsigned8, read-only
Boolean, read-only, persistent
Boolean, read-only, persistent
Boolean, read-only, persistent
Boolean, read-only, persistent Unsigned8, read-only, persistent
Boolean, read-only, persistent Unsigned8, read-only, persistent
Boolean, read-only, persistent
Unsigned8, read-only
Boolean, read-only, persistent Boolean, read-only, persistent
Unsigned8, read-only, persistent Unsigned16, read-only, persistent

Description
DisableOTADowngrades Set the attribute to TRUE if the OTA client shall prohibit downgrades to an earlier version
MGMTLeaveWithoutRejoinEnabled Set the attribute to FALSE, the node SHALL ignore MGMT Leave Without Rejoin commands that do not include APS encryption using the TC link key.
NWKRetryCount Number of network-level retries that will be made, in a row, in case that a MAC data request fails. “3”
MACRetryCount Number of MAC Level Retries the device performs when sending a unicast command, not including APS retries. “3”
RouterCheckInEnabled set to TRUE if the router’s check-in algorithm has been enabled through the ‘Enable Periodic Router Check-Ins’ command. “FALSE”
TouchlinkInterpanEnabled set the attribute to FALSE if support for Touchlink Interpan messages has been disabled On the device. “TRUE”
WWAHParentClassificationEnabled Set the attribute to TRUE, then the device SHALL enable the WWAH Parent Classification Advertisements feature. “FALSE”
WWAHAppEventRetryEnabled Set the attribute to TRUE if the WWAH Application Event Retry Algorithm is enabled. “FALSE”
WWAHAppEventRetryQueueSize This attribute is the queue size for re-delivery attempts in the WWAH Application Event Retry Algorithm. “32”
WWAHRejoinEnabled Set this attribute TRUE if the WWAH Rejoin Algorithm (described below) is enabled. “FALSE”
MACPollFailureWaitTime This attribute describes the time in seconds the device waits before retrying a data poll when a MAC level data poll fails for any reason. “2”
ConfigurationModeEnabled Set the attribute TRUE, the device will accept all ZDO commands without APS encryption. Set the attribute FALSE, all ZDO commands except those specified in [R9] should be disabled (unless sent encrypted using the Trust Center Link Key)
CurrentDebugReportID This attribute depicts the ID of the current debug report stored on the node. A value of 0x00 indicates that no debug report is available. “0”
TCSecurityOnNwkKeyRotationEnabled Set the attribute TRUE, the node processes network key rotation commands, specifically APS Transport Key, which are sent via unicast and are encrypted by the Trust Center Link Key.
WWAHBadParentRecoveryEnabled Set the attribute TRUE, the end device enables the WWAH Bad Parent Recovery feature described as in [R9]. “FALSE”
PendingNetworkUpdateChannel This attribute describes the channel number of the only channel the device accepts in a ZDO Mgmt Network Update command (and/or a Mgmt Network Enhanced Update command).
PendingNetworkUpdatePANID This attribute contains the only short PAN ID the device SHALL accept in a NLME Network Update command.

18

Attribute 0x0013
0xFFFD

Type Unsigned16, read-only, persistent
unsigned16

Description
OTAMaxOfflineDuration This attribute describes the maximum time in seconds the device may be unavailable after completing its OTA download (while restarting, etc). “60”
ClusterRevision The version of the cluster specification that this implementation adheres to.

Cluster commands supported:

Command 0x00 0x01 0x02
0x03 0x04
0x05 0x06 0x07
0x08
0x09
0x0A 0x0B 0x0C 0x0D 0x0E
0x0F 0x10
0x11 0x12 0x13

Description
Enable APS Link Key Authorization This command enforces that all cluster commands for the cluster have APS level security.
Disable APS Link Key Authorization This command removes the enforcement of APS level security on cluster commands.
APS Link Key Authorization Query On receipt of this command, a device generates an appropriate APS Link Key Authorization Query Response command and unicast it to the requestor.
Request New APS Link Key On receipt of this command, a device requests a new Trust Center Link Key from the Trust Center.
Enable WWAH App Event Retry Algorithm This command enables using the WWAH App Event Retry Algorithm to increase reliability of these events when the device temporarily loses contact with the hub.
Disable WWAH App Event Retry Algorithm This command disenables using the WWAH App Event Retry Algorithm.
Request Time This command enables a device to obtain the current values of Time Cluster attributes from the Time Cluster Server.
Enable WWAH Rejoin Algorithm This command enables applying WWAH Rejoin Algorithm on end devices to recover and reconnect to the Zigbee network faster when connection is lost.
Disable WWAH Rejoin Algorithm This command disables applying WWAH Rejoin Algorithm and devices are supposed to go back to the default behavior.
Set IAS Zone Enrollment Method This command is used to dynamically change among the 3 enrollment methods of an IAS Zone Server specified in ZCL specification.
Clear Binding Table On receipt of this command, a device clears its binding table.
Enable Periodic Router Check-Ins This command enables the Periodic Router Check-in WWAH functionality with the Check-In Interval specified.
Disable Periodic Router Check-Ins This command disables the router periodic check-in behavior (if enabled).
Set MAC Poll Failure Wait Time This command enables to update the MACPollFailureWaitTime attribute with the Wait Time value passed.
Set Pending Network Update This command enables updating the PendingNetworkUpdateChannel and PendingNetworkUpdatePANID attributes with the Channel and PAN ID values passed, to protect the device from unauthorized Network Update.
Require APS ACKs on Unicasts This command enforces that all unicast commands have APS ACKs enabled.
Remove APS ACKs on Unicasts Requirement This command enables to roll back any changes caused by the Require APS ACKs on Unicasts command. The device can default back to its normal settings.
APS ACK Requirement Query This command is meant to query the current Require APS ACKs on Unicasts settings.
Debug Report Query This command enables requesting the debug report based on the specified Debug Report ID.
Survey Beacons On receipt of this command, the device performs a scan for beacons advertising the device’s network (using the default scan duration), generate a Survey Beacons Response command and unicast it to the requestor.

19

Command 0x14 0x15
0x16 0x17 0x18 0x19
0x1A 0x1B 0x1C
0x1D
0x1E
0x1F

Description
Disable OTA Downgrades On receipt of this command, a device disallows downgrades of all components of its firmware.
Disable MGMT Leave Without Rejoin On receipt of this command, a device responds with NOT_AUTHORIZED to MGMT Leave Without Rejoin commands that don’t contain APS encryption using the TC Link key.
Disable Touchlink Interpan Message Support On receipt of this command, a device ignores Touchlink interpan messages.
Enable WWAH Parent Classification On receipt of this command, a device enables the WWAH Parent Classification Advertisements feature.
Disable WWAH Parent Classification On receipt of this command, a device disables the WWAH Parent Classification Advertisements feature.
Enable TC Security On Nwk Key Rotation On receipt of this command, a device processes only network key rotation commands, specifically APS Transport Key, which are sent via unicast and are encrypted by the Trust Center Link Key.
Enable WWAH Bad Parent Recovery On receipt of this command, a device enables the WWAH Bad Parent Recovery feature.
Disable WWAH Bad Parent Recovery On receipt of this command, a device disables the WWAH Bad Parent Recovery feature.
Enable Configuration Mode This command enables to protect the device from unauthorized configuration changes during normal optional, i.e., to to put a device back into its default state where configuration changes are allowed.
Disable Configuration Mode On receipt of this command, a device disables processing of all ZDO commands that have not been encrypted using the Trust Center Link key.
Use Trust Center for Cluster This command forces the device to use ONLY the Trust Center as the cluster server for the set of clusters specified and persists this configuration across reboots.
Trust Center for Cluster Server Query On receipt of this command, a device generates an appropriate Trust Center for Cluster Server Query Response command and unicast it to the requestor.

6.4.10. Identify Cluster (Client)
The Identify cluster client takes on the role of the Finding & Binding initiator. Once activated, H1 initiates the identification process by broadcasting identify query request command to detect target(s) operating in identify mode.

Cluster commands supported:

Command 0x01

Description
Query Identify Broadcasts this command to identify suitable binding targets. Once target devices are identified, they will be queried for matching descriptors.

6.4.11. Time Cluster (Client)
The Time cluster client locates Time cluster servers in the same network to synchronize its internal real-time clock, preferable one that is connected to the internet and provides a high-quality time-base. Valid timing information is essential for utilizing pre-defined weekly set-point schedules, whether it’s automatically synchronized with a remote time-base or manually set through the local MMI on H1. Using data received from a time server, including the time zone or/and the daylight saving time, the unit can adjust its local time automatically . [15] This feature is especially beneficial for tasks like setting and executing a thermostat schedule accurately.

20

6.4.12. Over-the-Air Upgrade Cluster (Client) The current image type for H1 is 0x7B2D . [16] You may request the latest firmware in ZigBee OTA image format to upgrade devices in the field using your own OTA server and back-end. If you operate the H1 together with the ZigBee/Ethernet Gateway ubisys G1, the latest firmware for H1 will always be available automatically and you do not need to request it explicitly.
6.4.13. Thermostat Cluster (Client) The Thermostat cluster client receives attribute reports for setpoints, local temperature, occupancy, system mode etc. from a leader [17] thermostat in a group of thermostats. This allows the leader to align one or more thermostats in the same space.
6.4.14. Temperature Measurement (Client) The Temperature Measurement cluster client receives attribute reports from remote temperature sensors and interprets the received measured values as remote temperature, internally maintained through the manufacturer-specific attribute RemoteTemperature. H1 is equipped with a temperature sensor internally. Hence it supports temperature acquisition not only via internal mechanisms but also via receiving temperature reports sent by external sensors. For heating regulation, a received remote temperature value, as long as valid, takes precedence over the locally measured one.
6.4.15. Relative Humidity Measurement (Client) The Relative Humidity Measurement cluster client receives attribute reports from humidity sensors. Reports are currently not evaluated; this feature is intended for future use.
6.4.16. Occupancy Sensing (Client) The Occupancy Sensing cluster client receives attribute reports from occupancy sensors and interprets the measured values as occupancy in the heating space. This will bring different heating setpoints into effect. Notice that this feature can be used in one of several ways: Classic zigbee occupancy sensors can be directly bound such that they send their reports directly to the thermostat endpoint. Similarly, zigbee green power occupancy sensors can be directly paired with the thermostat endpoint and used to the same effect. A gateway can collate occupancy reports from different devices in the same space and provide a single occupancy report to the thermostat. Notice this might interface with occupancy reports from a leader thermostat. Make sure you use either approach, otherwise the most recent report will currently take precedence.
21

[1] Available in ZigBee stack version 1.60 and above. Legacy ZCP requirement ­ do not use in applications [2] Available in Zigbee stack version 1.56 and above. [3] Available in Zigbee stack version 1.61 and above. [4] Attribute ID changed since application version 1.5.0. Prior, it used to be 0x0003. [5] Attribute ID changed since application version 1.5.0. Prior, it used to be 0x0004. [6] Since application version 1.4.0. Prior, the attribute was unsupported. [7] Attribute ID changed since application version 1.5.0. Prior, it used to be 0x0005. [8] Since application version 1.5.0. Prior, the attribute was unsupported. [9] Since application version 1.6.0. Prior, the attribute was unsupported. [10] Since application version 1.6.0. Prior, the attribute was unsupported. [11] Since application version 1.6.0. Prior, the attribute was unsupported. [12] Attribute ID changed since application version 1.5.0. Prior, it used to be 0x0013. [13] Attribute ID changed since application version 1.5.0. Prior, it used to be 0x0014. [14] Attribute ID changed since application version 1.5.0. Prior, it used to be 0x0015. [15] This feature has been supported since application version 1.6.0. Before that, it was unsupported. [16] Since application version 1.5.0. Prior, the image type used to be 0x7B0D. [17] An example of a suitable leader is the Legrand in-wall thermostat UI Model No. 0 663 40
22

7. Thermostat Heating Setpoints Schedules
H1 supports automated heating regulation based on pre-defined temperature setpoint schedules on a weekly basis. Currently, it supports two approaches for creating, adjusting, removing, or viewing one or more weekly heating setpoint schedules on associated days:
· Approach 1: Utilize the MMI on H1
Operations such as addition, modification or removal of weekly setpoint schedules can be conveniently and efficiently carried out by directly utilizing the MMI on H1. For information on how to set and configure heating schedules using MMI, please refer to Chapter 4. Schedules of the Heating Control H1 – Manual.
· Approach 2: From a management entity on a ZigBee network, utilize the radio interface to transmit the Zigbee ZCL Thermostat cluster commands such like Set Weekly Schedule, Get Weekly Schedule, or Clear Weekly Schedule to H1.
An example of such a management entity is the ubisys Gateway G1, in collaboration with the ubisys smart facility application.

Both approaches are basically compatible with each other, but it’s important to highlight the major differences when employing them to set heating setpoints for automated heating regulation through H1.

7.1. Weekdays configuration

The heating setpoint schedules on H1 can be configured for days on a weekly basis.

Approach 1: MMI
If no schedule has been set up yet, you can choose from the following combinations of weekdays to create unified schedules for the respective days:
– Option 1: all weekdays (Monday – Sunday) – Option 2: all workdays & weekend (Monday-Friday & SaturdaySunday) – Option 3: vacation days
The Option 1 and Option 2 will continue to be accessible until schedule differentiation is added for at least one of the respective days. Subsequently, configuration of setpoint schedules must be carried out for each weekday individually.

Approach 2: Over-the-air ZCL commands
The ZCL Thermostat cluster commands Set Weekly Schedule and Get Weekly Schedule include a field that specifies the weekdays or vacation days at which the heating setpoint schedules are associated to. This field is in bitmap format, allowing scheduled setpoints to potentially overlap across multiple days.
H1 supports receiving the Set Weekly Schedule and Get Weekly Schedule commands with the combination of any weekday specified and vacation days by the user.

The Option 3 is always accessible.

7.2. Format of setpoint schedules
If you create a setpoint schedule using the MMI on H1, the internally applied and stored schedule format, the so-called schedule slot format, is implemented. It differs sometimes slightly from the one created when receiving a ZCL Thermostat cluster Set Weekly Schedule command that utilizes the ZCL standard schedule transition format. H1 can handle both formats individually, but it doesn’t support a combination of them for the same weekly schedules. In other words, you must define weekly schedules in one of the two formats, but not a mix of them.

23

Format variant 1: Schedule Slot

Format variant 2 : ZCL Standard Schedule Transition

Each schedule slot actually consists of two transitions:

The definition of ZCL standard schedule transition for heating

setpoint, applied for the ZCL Thermostat cluster command Set

– Start transition, which contains two field:

Weekly Schedule and Get Weekly Schedule, can be found in the

(a). time of day, in minutes since midnight, which specifies the start ZCL specification [R4].

time of a heating duration period

(b). a heating setpoint to be applied at the associated start transition

time

Each standard schedule transition includes two fields:

(a). time of day, in minutes since midnight, which specifies the start

– End transition, which contains two fields:

time of a transition

(a). time of day, in minutes since midnight, which specifies the end (b). a heating setpoint to be applied since the transition start time

time of a heating duration period

(b). an end-mark with the hexadecimal integer value 0x8000

The MMI on H1 does not support adding and further modifying

indicating the end of applying the heating setpoint at this associated weekly schedules in the ZCL standard schedule transition format.

end transition time

This is the default format used for adding and further modifying weekly schedules through the MMI on H1.
Consider a sequence of schedule slots:

Consider a sequence of schedule transitions:

– Since each schedule slot has a defined duration with a specified – The start time of a schedule transition is inherently the end time of

start and end time, there may be instances during the day when H1 the proceeding transition.

does not have a heating setpoint schedule. In such scenarios, the

target heating temperature setpoint is determined based on the state – H1 never has duration periods without scheduled heating

of the Occupancy attribute. It applies either the Default Occupied temperature setpoint once at least one schedule transition is defined.

Heating Setpoint or Unoccupied Heating Setpoint attribute value until

the start time of the next available schedule slot.

– A heating setpoint schedule created in this manner may extend

across several days until the commencement of any subsequent

– On H1 through MMI, this type of schedule slot is only applicable to schedule transition.

a specified combination of week days.

When transmitting a ZCL Thermostat cluster Set Weekly Schedule Consider H1 is already equipped with weekly schedules set up via

command to H1, you can also submit weekly schedule definitions in the MMI, it receives a ZCL Thermostat cluster Set Weekly Schedule

the slot format:

command containing schedule definitions in the ZCL standard

schedule transition format,

– The count of schedule transitions included must be an even number

2m, so that m pairs of transition slots can be generated in fact.

– it will result in the removal of the whole stored weekly schedules on

H1.

– The heating setpoint value of the second transition in each transition

pair should be set to the hexadecimal end-mark value 0x8000.

– The newly received schedules will then be applied.

– The configuration of weekly schedules through MMI will be in this case deactivated until all schedules using the standard ZCL pattern are entirely deleted at a later time.

Regardless of the schedule format currently in use, H1 always shows the current scheduled temperature setpoint in the bottom left corner of the display, if available.

While the formats differ, the fundamental data structure, encompassing the fields of time of day and temperature setpoint, remains identical in both format definitions. This means you can always employ a ZCL Thermostat cluster Set Weekly Schedule command via over-the-air transmission to set up weekly schedules, whether using the ubisys schedule slot format or the ZCL standard schedule transition format.

7.3. Number of daily heating setpoint schedules
By default, the attribute NumberOfDailyTransitions is set to 10, indicating the H1’s capacity to handle daily schedule transitions. The variations in the format of setpoint schedules lead to different maximum numbers of daily heating setpoint schedules:

Number of heating setpoints for Sequence based upon Schedule Slot : 5
You can define up to five schedule duration periods per day.

Number of heating setpoints for Sequence based upon ZCL Standard Schedule Transition : 10
You can define up to ten schedule transition changes per day.

24

7.4. Schedule Configuration Examples
Here are a few ZCL Thermostat cluster command frame examples highlighting that the Approach 2 is utilized to configure temperature setpoint schedules. These over-the-air ZCL Thermostat cluster commands should be always sent to the endpoint #1 and cluster 0x0201 of a target H1. For creating the ZCL Thermostat cluster SetWeeklySchedule command, both the schedule slot and the ZCL standard schedule transition formats for schedule configuration are showcased.
Examples of applying the Approach 1 to enable temperature setpoint schedules can be found in Chapter 4. Schedules of the Heating Control H1 – Manual.
· Example 1. Clear all existing heating setpoint schedules
ZCL thermostat cluster command Clear Weekly Schedule
0x03

Item 0x03

Description Identifier of the command ClearWeeklySchedule

· Example 2. Clear the heating setpoint schedules for specific days Clear the setpoint schedules on Tuesday:

ZCL thermostat cluster command Set Weekly Schedule

0x01 0x00 0x04 0x01

Item 0x01 0x00 0x04 0x01

Description Identifier of the command SetWeeklySchedule Field NumberOfTransitionsForSequence set to 0 Field DayOfWeekForSequence set to 0x04 (Tuesday) Field ModeForSequence set 0x01 (Heat)

Clear the heating setpoint schedules from Monday to Friday:

ZCL thermostat cluster command Set Weekly Schedule

0x01 0x00 0x3E 0x01

Item 0x01 0x00 0x3E 0x01

Description Identifier of the command SetWeeklySchedule Field NumberOfTransitionsForSequence set to 0 Field DayOfWeekForSequence set to 0x3E (Monday-Friday) Field ModeForSequence set 0x01 (Heat)

Clear the heating setpoint schedules for vacation days:

ZCL thermostat cluster command Set Weekly Schedule

0x01 0x00 0x80 0x01

25

Item 0x01 0x00 0x80 0x01

Description Identifier of the command SetWeeklySchedule Field NumberOfTransitionsForSequence set to 0 Field DayOfWeekForSequence set to 0x80 (Away or Vacation) Field ModeForSequence set 0x01 (Heat)

· Example 3. Query the heating setpoint schedules for specific weekdays Query the existing temperature setpoint schedules for weekend:

ZCL thermostat cluster command Get Weekly Schedule

0x02 0x41 0x01

Item 0x02 0x41 0x01

Description Identifier of the command GetWeeklySchedule Field DaysToReturn set to 0x41 (Saturday and Sunday) Field ModeToReturn set 0x01 (Heat)

Query the existing temperature setpoint schedules for vacation days:

ZCL thermostat cluster command Get Weekly Schedule

0x02 0x80 0x01

Item 0x02 0x80 0x01

Description Identifier of the command Get Weekly Schedule Field DaysToReturn set to 0x80 (Vacation days) Field ModeToReturn set 0x01 (Heat)

· Example 4. Set the heating setpoint schedules for specific weekdays Set three heating setpoints on all workdays utilizing the ubisys schedule slot format:
Following settings are intended on H1:

Heating Period 1 1 1 2 2 2 3 3 3

Parameter Start Time End Time Target Temperature Start Time End Time Target Temperature Start Time End Time Target Temperature

Value 00:00 (0x0000) 06:00 (0x0168) 15°C (0x05DC) 06:00 (0x0168) 22:00 (0x0528) 24°C (0x0960) 22:00 (0x0528) 24:00 (0x05A0) 15°C (0x05DC)

ZCL thermostat cluster command SetWeeklySchedule

0x01 0x06 0x3E 0x01 0x00 0x00 0xDC 0x05 0x68 0x01 0x00 0x80 0x68 0x01 0x60 0x09 0x28 0x05 0x00 0x80 0x28 0x05 0xDC 0x05 0xA0 0x05 0x00 0x80

Item 0x01
26

Description Identifier of the command SetWeeklySchedule

Item 0x06 0x3E 0x01 0x00 0x00 0xDC 0x05 0x68 0x01 0x00 0x80 0x68 0x01 0x60 0x09 0x28 0x05 0x00 0x80 0x28 0x05 0xDC 0x05 0xA0 0x05 0x00 0x80

Description Field NumberOfTransitionsForSequence set to 0x06 indicating 3 slots, i.e., 6 transitions Field DayOfWeekForSequence set 0x3E (From Monday to Friday) Field ModeForSequence set 0x01 (Heat) Field TransitionTime 1 set 0x0000 (StartTime 00:00) Field HeatSetPoint 1 set 0x05DC (15°C) Field TransitionTime 2 set 0x0168 (EndTime 06:00) Field HeatSetPoint 2 set 0x8000 (EndMark) Field TransitionTime 3 set 0x0168 (StartTime 06:00) Field HeatSetPoint 3 set 0x0960 (24°C) Field TransitionTime 4 set 0x0528 (EndTime 22:00) Field HeatSetPoint 4 set 0x8000 (EndMark) Field TransitionTime 5 set 0x0528 (StartTime 22:00) Field HeatSetPoint 5 set 0x05DC (15°C) Field TransitionTime 6 set 0x05A0 (EndTime 24:00) Field HeatSetPoint 6 set 0x8000 (EndMark)

Upon receipt of this over-the-air ZCL Thermostat cluster SetWeeklySchedule command in the ubisys schedule slot format,
all currently stored schedules will be removed, if they are defined in the ZCL standard schedule transition format, if any
the currently stored schedules for Monday to Friday will be replaced by the ones given in the received command frame, if any and applying the same slot format
the new schedules will be applied
the just added schedules can be modified either via MMI on H1 or upon receipt of further over-the-air ZCL thermostat schedule commands
the heating regulation on the specified weekdays occurs according to these new schedules
the heating regulation on other weekdays, in this case on Saturday and Sunday, remains unchanged
Set three heating setpoints on all weekdays utilizing the ZCL standard schedule transition format:
Following settings are intended:

Setpoint Transition 1 1 2 2 3 3

Parameter Start Time Target Temperature Start Time Target Temperature Start Time Target Temperature

Value 00:00 (0x0000) 15°C (0x05DC) 06:00 (0x0168) 24°C (0x0960) 22:00 (0x0528) 15°C (0x05DC)

ZCL thermostat cluster command SetWeeklySchedule
0x01 0x03 0x3E 0x01 0x00 0x00 0xDC 0x05 0x68 0x01 0x60 0x09 0x28 0x05 0xDC 0x05

27

Item 0x01 0x03 0x3E 0x01 0x00 0x00 0xDC 0x05 0x68 0x01 0x60 0x09 0x28 0x05 0xDC 0x05

Description Identifier of the command SetWeeklySchedule Field NumberOfTransitionsForSequence set to 0x03 indicating 3 transitions Field DayOfWeekForSequence set 0x3E (From Monday to Friday) Field ModeForSequence set 0x01 (Heat) Field TransitionTime 1 set 0x0000 (StartTime 00:00) Field HeatSetPoint 1 set 0x05DC (15°C) Field TransitionTime 2 set 0x0168 (StartTime 06:00) Field HeatSetPoint 2 set 0x0960 (24°C) Field TransitionTime 3 set 0x0528 (StartTime 22:00) Field HeatSetPoint 3 set 0x05DC (15°C)

Upon receipt of this over-the-air ZCL Thermostat cluster SetWeeklySchedule command in the ZCL standard schedule transition format,

all currently stored schedules will be removed, if they are defined in the ubisys schedule slot format, if any
the currently stored schedules for Monday to Friday will be replaced by the ones given in the received command frame, if any and applying the same standard transition format
the new schedules will be applied
the just added schedules can be modified only upon receipt of further over- the-air ZCL commands that utilize the ZCL standard schedule transition format
the heating regulation on the specified weekdays occurs according to these new schedules
the heating regulation on other weekdays, in this case on Saturday and Sunday, may be affected as well, i.e., the last heating setpoint (15°C) on Friday could take into effect beyond the midnight to Saturday, till the next scheduled setpoint

28

8. Physical Dimension

Figure 3. Heating Control H1 ­ Dimensions

If the ubisys heating control H1 does not fit on the valve of your radiator, you will probably need an adapter. The valve adapter is mounted between the H1 and your radiator valve. You can refer to the Valve Adapter List provided by ubisys. The list does not claim to be complete. For other valve types, other adapters may be required.

29

9. Ordering Information

The following tables list the product variants available. Use the specified order code for your orders.

Orders for products sold under different brand names need to be placed with the respective vendor.

For any customized versions, please contact ubisys sales. OEM customers may order these products with the dimming mode pre-configured to either “automatic”, “leading edge” or “trailing edge”.

Vendor/Brand ubisys

Order Code 1267

Description Heating Regulator H1

30

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: www.ubisys.de/en/smarthome/terms.html
31

11. Declaration Of Conformity

We ­ ubisys technologies GmbH, Neumannstraße 10, 40235 Düsseldorf, Germany ­ declare under our sole responsibility that the ubisys Heating Regulator H1 with order codes as detailed in Chapter 9 under the trade name “ubisys” to which this declaration relates are in conformity with the following directives and standards:

Directive/Standard 2014/53/EU 2014/30/EU 2014/35/EU 2012/19/EU 2011/65/EU EN 300 328 V2.2.2 EN 300 440 V2.2.1
EN 301 489-1 V2.1.1 IEEE 802.15.4:2020
ZigBee 3.0

Description/Scope Radio Equipment Directive (RED) Electromagnetic Compatibility Directive (EMC) Low Voltage Directive (LVD) Waste Electrical and Electronic Equipment Directive (WEEE) Restriction of Hazardous Substances Directive (RoHS) ERM; Wideband transmission systems; 2.4 GHz ISM band ERM; Radio equipment to be used in the 1 GHz to 40 GHz frequency range EMC IEEE Standard 802 ­ Part 15.4: Low-Rate Wireless Personal Area Networks (LR-WPANs) ZigBee 2017 with Green Power

Düsseldorf, Germany

September 16, 2021

Place of issue Dr.-Ing. Arasch Honarbacht

Date of issue Managing Director, Head of Research & Development

Full name of Authorized Signatory

Title of Authorized Signatory

Signature

Seal

32

12. Revision History

Revision 0.1 1.0

Date 17/08/2022 04/12/2023 29/02/2024

20/03/2024

2.0

26/03/2024

Remarks
Initial draft
Initial Public Version
Add two new features: (1) Support updating local time automatically based on time zone and day light saving time received from a time server (2) Support the Open Window Detection to adapt the heating behavior automatically
Add two new features: (1) Offer support for constraining the range of valve opening percentages within the designated operational area to prevent potential cavitation noise. (2) Support the device enter back-up mode and apply backup heating demands with different pre-sets for summer and winter seasons due to factors such as insufficient battery power.
Update the footnotes regarding the application version 1.6.0 which includes the four newly added and implemented features.

33

13. Contact
ubisys technologies GmbH Neumannstr. 10 40235 Düsseldorf Germany T: +49. 211. 54 21 55 – 19 F: +49. 211. 54 21 55 – 99 www.ubisys.de info@ubisys.de
34

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>