ubisys H1 Firmware Change Logs

Version Identification 

• OTA file version: 0172044D
• Application: 1.7.2
• Stack: 4.4.13

New in version 1.7.2

• Bug-fix: When applying a generic weekly schedule from a third-party controller, unrelated display menu items might have inadvertently become unavailable. Note: Using a generic ZCL schedule that does not conform to the ubisys proprietary extended scheme is possible and supported, but this will lead to the schedule menu items being limited to „delete all schedules“, editing basic (non-extended) schedules from the local display is not supported.

Version Identification 

• OTA file version: 0170044D
• Application: 1.7.0
• Stack: 4.4.13

New in version 1.7.0

• New Feature: Open window detection. When open window detection is enabled, a sudden temperature sag will cause the H1 to lower the current heating setpoint and reduce the heating demand to save energy. It will return to the previous setpoint automatically, once the temperature increases or after a predefined timeout. This feature can be activated using the local user interface (display) or via ubisys proprietary over-the-air ZCL command
• Added support for adopting time zone information obtained from a remote time server
• Introduced functionality to specify optional minimum and maximum limits for heating demand. This feature allows users to confine heating demand within a defined range, if needed. For example, some valves generate high-pitch noise when they are barely open as the water flows with pressure through a tiny hole and depending on valve construction this could lead to audible noise. A lower bound can be imposed on the heating demand to make sure that the valve is either closed, or when it is open, it is open at the specified minimum level
• Introduced “backup” mode to better cope with low-battery situations. When the battery runs out, automatic heating regulation is disabled, and H1 maintains a configurable valve opening level, e.g. 25%, to prevent erratic regulation behavior when the motor is unable to provide sufficient torque to close the valve
• Bug-fix: In some rare edge-cases there might have been a potential for the watch-dog timer not being reset as expected
• Various improvements and enhancements to the display menu

ubisys Compact7B Stack Changes between 4.3.0 and 4.4.7

• Common Functionality
  • Persistent Storage 2.0: Added various improvements and optimizations for internal flash memory management during the startup phase for improved resiliency
  • Added sanity checks for ubisys proprietary input configurations, which are supplied over-the-air
  • Improved the start-up behavior of the input state machine (deferred initialization)
• Zigbee Cluster Library
  • Time client: Extended the permissible maximum interval between periodic server queries. Prior to this change, the interval has to be less than about 20 hours
  • OTA client: Improved handling of duplicate image block data, i.e. data that has already been fully or partially received. This prevents unnecessary retries and speeds up the overall download process
  • Added support for restoring factory default reporting configurations using the factory default configuration of an arbitrary (other) endpoint as template
• Zigbee Network Core Stack
  • Improved resilience: Account for the case that retry of a fragmented APS transmission might occur even after all fragments have been received
  • Resolved an issue where the ‘extended nonce’ flag might not have been set when transmitting an APS encrypted Update Device command

ubisys Compact7B Stack Changes between 4.4.7 and 4.4.13

• Common Functionality
  • Provided applications/platforms an opportunity to interleave with certain computationally intensive procedures
  • Added verification steps when OTA images are stored in external flash
• Zigbee Cluster Library
  • Color Control server: Improved the internal application interface regarding the state of color transitions
  • Color Control server: Improved management of Enhanced Color Mode (CCB 4071)
  • Color Control server: Resolved an issue where initiating an instant color transition could result in a division-by-zero exception on some platforms
  • Enhanced the attribute framework such that applications need not provide updated values when refreshing attributes if such updated values are not available or desired
  • Addressed an issue where the sequence of operations was undefined, potentially lead to incorrect processing of manufacturer-specific inbound ZCL frames on certain platforms. Note: This affects only a new platform, not existing platforms and products
  • Fixed an issue where an attribute with dynamic storage might not have allocated storage at initialization time
• Zigbee Network Core Stack
  • Improved resilience: Add defensive code to guard against invalid source route information embedded into a network frame. Based on a field issue with a third-party Zigbee stack
  • Simplified and improved the way of creating ZDO simple descriptors

Version Identification 

• OTA file version: 01520430
• Application: 1.5.2
• Stack: 4.3.0

New in version 1.5.2

• Make local temperature reflect the values measured and reported by a remote temperature sensor. Similarly, apply the temperature offset setting for local sensor fine-tuning when reporting local temperature. This provides a consistent experience across the local display and ecosystem user interfaces that display the same information.

Version Identification 

• OTA file version: 01510430
• Application: 1.5.1
• Stack: 4.3.0

New in version 1.5.1

• Added regular watch-dog timer reset during persistent storage operations that are not time-bound. This is a critical fix for all Series 2 products that shall be applied immediately and also highly recommended for all other products

ubisys Compact7B Stack Changes between 4.2.7 and 4.3.0

• Common functionality
  • Added application/platform-specific hooks to Persistent Storage 2.0 when swapping cached pages

Note: To install this firmware version, at least the version 1.5.0 is required.

Version Identification 

• OTA file version: 01500427
• Application: 1.5.0
• Stack: 4.2.7

New in version 1.5.0

• Various improvements related to the linear drive
• Added support for heating regulation based on measurements received from Zigbee temperature sensors via attribute reporting
• Migrated some manufacturer-specific attributes’ identifiers for consistency across the product range (H1, H10 and OEM products)
• Changed the OTA image type from 0x7b0d to 0x7b2d to prevent potential compatibility issues (legacy persistent storage, new firmware, or vice versa)

ubisys Compact7B Stack Changes between 4.2.2 and 4.2.7

• Zigbee Network Core Stack
  • Various improvements and optimizations regarding the network rejoin behavior of sleepy end-devices)

Version Identification 

• OTA file version: 01400422
• Application: 1.4.0
• Stack: 4.2.2

New in version 1.4.0

• Various enhancements and improvements provided by the stack roll-up (see stack change log for details)
• Added support for setting vacation mode setpoints using the menu on the device’s LCD display. Vacation periods are now treated like a virtual weekday and 5 time slots are available for different temperature setpoints while away
• Schedules now manageable over-the-air using standard ZCL commands
• Added a manufacturer-specific attribute to allow managing vacation mode over-the-air
• Scheduling improvements with respect to certain rare edge cases
• Various improvements related to the display and menu

ubisys Compact7B Stack Changes between 4.1.2 and 4.2.2

• Common Functionality
  • Persistent Storage: Improved robustness against power failures during factory resets
  • Persistent Storage: General speed optimizations for second-generation journaling token storage system. Further speed-optimizations for garbage collection and progressive, piecemeal maintenance for improved responsiveness
  • Push-button event handling for next-generation hardware (settling time option)
• Zigbee Cluster Library
  • Enabled cancelling service locating processes, if needed; available for IAS Zone server, Poll Control server, OTA client and Time client clusters
  • Enabled cancelling particular outbound ZCL requests, if needed
  • Thermostat cluster: Added support for changing schedules over-the-air
  • Window covering cluster: Improved support for back-to-back “Go To Lift” commands
  • OTA client: Abort ongoing OTA download and service locating process when permanently leaving the network
  • OTA client: Clear OTA server configuration when permanently leaving the network
  • Reporting configuration: Omit target address information from persistent storage entries (experimental feature, now deprecated)
  • Fixed an issue, where a ZCL “Report Attribute” command without payload may be repeatedly transmitted (edge case, did not affect existing devices)
  • Fixed an issue, where the remaining packet capacity might have been inaccurate when assembling a ZCL frame with variable length payload (edge case, did not affect existing devices)
• Zigbee Network Core Stack
  • Enabled automatic routing loop detection and resolution
  • Accelerate retrieval of APS security material from persistent storage
  • Improved resilience against power failures when updating APS security material in persistent storage
  • Various improvements and optimizations regarding MAC data poll on sleepy end-devices
  • Various improvements and optimizations regarding indirect transmissions on routers
  • More rigid filtering on sleepy end-devices regarding unsolicited broadcast frames received while polling the parent
  • Enabled cancelling particular outbound ZDO requests pending a response, if needed
  • Now utilizing average LQA for poor parent link assessment, mitigating the impact of one-off RF disturbances
  • Ignore inbound MAC data requests during router network startup
  • Improved resilience to parent link failures during trust center link-key exchanges
  • Fixed an issue, where the next indirect transmission may have been instigated too early
  • Fixed an issue, where the master key on a trust center device or the exchanged authentication token on a router device is not reset when necessary (edge case, did not affect existing devices)

Version Identification 

• OTA file version: 01310412
• Application: 1.3.1
• Stack: 4.1.2

ubisys Compact7B Stack Changes between 4.0.3 and 4.1.2

• Common Functionality
  • Power cycle factory reset sequence timing changed to ‘10s on’, ‘10s off’, … cycles across all products and underlying platforms. This is to accommodate upcoming products and platforms and retain a unified factory reset power cycle. Significant gains in power efficiency lead to SoCs remaining powered for several seconds after the power supply has been cut
  • Enhanced input action engine to support emitting manufacturer-specific commands. These may be used, for example, to replicate Matter Generic Switch behavior in Zigbee devices for seamless bridging of inputs to Matter
  • Persistent Storage: Improve robustness against power failures during garbage collection
  • Persistent Storage: Slight tweaks to wear-levelling algorithm
• Zigbee Cluster Library
  • Added support for read attributes structured and write attributes structured. This enables unlimited configuration options for C4 and other products with programmable input configurations, including four dimmer switches, for instance
  • Added safeguards against some misbehaving third party OTA servers
• Zigbee Network Core Stack
  • Fixed an issue, where under rare circumstances, false address conflicts could have been flagged
  • Improved link status processing
  • Routing has been optimized to address certain rare edge cases and improve interoperability with some third-party devices
  • Improved resilience of trust center link-key exchange (when stack is reset)
  • Fixed an issue, where the address comparator misbehaved for some rare constellations
  • Joining and rejoining improved by adding quick MAC association retries with adjustable attempt limit
  • Processing of leave requests with certain status codes has been improved
  • Improved the behavior of leave processing while rejoining
  • Improved robustness by ignoring beacons that arrive after scanning has completed and before joining succeeded
  • Improved resilience to malformed beacon frames
  • Improved link quality assessment on certain platforms
  • Added support for new SoCs

Version Identification 

• OTA file version: 01200403
• Application: 1.2.0
• Stack: 4.0.3

ubisys Compact7B Stack Changes between 3.0.0 and 4.0.3

• Zigbee 2023 compliant (passes all compliance tests, certification pending)
  • Asymmetric key agreement before network admission with optional device interview
  • Support for all mandatory and all optional features defined in Zigbee 2023 in all possible device roles: trust center, router, sleepy end-device, non-sleepy end-device
  • Support for all cryptographic suites supported by Zigbee 2023, i.e. SPEKE/Curve25519/AES-MMO-128/HMAC-AES-MMO-128 and SPEKE/Curve25519/SHA-256/HMAC-SHA-256-128
  • Fully standard-compliant Works With All Hubs feature support retaining full compatibility with the pre-standard Amazon Works With All Hubs cluster
  • Negotiation of fragmentation capabilities
  • Fragmentation support for new ZDO commands
  • APS security frame counter synchronization
  • Standardized trust center swap-out (trust center and joined devices)
  • Standardized network-level retries, including data poll retries for sleepy end-devices
• Enhanced product-level configuration options for customized stack behavior
• Optimizations to improve routing and instant network connectivity on start-up
• Ongoing maintenance of the code base: Restructuring, refactoring and consolidating
• Round-up of bug-fixes and performance improvements

Note: This change log is a generic stack change log. Products incorporating the stack can choose to enable specific feature sets. For example, the 2023 feature set can be selectively disabled in products to support a graceful transition to Zigbee 2023 in progressive roll-outs. In addition, while the stack supports all variations of key agreement suites, end-products might support only a reasonable subset. Specifically, ubisys products will prefer SPEKE/Curve25519/AES-MMO-128/HMAC-AES-MMO-128 for all Zigbee 2023, Zigbee Direct 1.0 and digital signatures of OTA images as this suite provides the best blend of security, performance and resource utilization.

Version Identification 

• OTA file version: 011C0300
• Application: 1.1.12
• Stack: 3.0.0

ubisys Compact7B Stack Changes between 2.4.0 and 3.0.0

• Added support for I2C TAP
• Added support for a unified and fully configurable join/rejoin algorithm with back-offs and retries at the stack level
• Reject trust center rejoin on a distributed security network (CSA incident no. 2021-ZP-0401)
• Start TCLK exchange if an end device could not successfully finish TCLK exchange during its initial joining and has just rejoined
• Improved sleep management: Checking both transmission and reception queues for pending packets, if necessary
• Extended the advanced parent link maintenance mechanism by the new criterion “poor poll control reactivity”
• More granular startup progress notifications, including kick-off of a Touch Link commissioning procedure
• Stop ongoing join/rejoin retry attempts when Touch Link commissioning procedure is instigated
• Encapsulated the All Hubs cluster’s dependency on the Touch Link server, IAS Zone server and Time client clusters, for better modularity
• Added Enhancements to the Thermostat cluster
• Made the hard limit for the scene table capacity configurable
• Added support for the Relative Humidity Measurement cluster
• Added framework support for initiating enroll request and IAS zone status change indication via the ZCL request queue
• Added framework support for time query initiated by a Time client cluster
• Prohibit automatic CIE detection by default; application is still able to instigate it though should legacy systems require it
• Explicitly stop fast polling mode as soon as no more response frame is pending
• Resume network activity if a router device just failed a rejoin attempt
• Enhancement: PAN-ID and permit joining state changes are forwarded to application clusters
• Bug-fix: Under rare circumstances, a frame might linger in the transmission queue without being actually sent
• Bug-fix: Potential overflow of 64-bit timer values might occur when unsigned arithmetic is used for comparison of due times
• Bug-fix: During MAC association, if an unrelated frame is being received via data polling, MAC association might be incorrectly terminated; account for this case and retry if permissible
• Bug-fix: Periodical polling timer used to be unconditionally kept alive, even in case of data poll failure; temporarily cancel it to avoid interference with subsequent retry attempts. Once succeeded, the periodical polling timer will be reinstated for its normal usage.
• Bug-fix: When assessing MAC capability changes for a rejoining device verify the “Device Type” and “Receiver on when Idle” bits only
• Bug-fix: Skip route discovery table verification diagnostics in case of an end device
• Bug-fix: Limit the use of incoming APS security material to few select cases only
• Bug-fix: Periodical reporting on a cluster attribute could lead to undue delays of reports for other clusters
• Bug-fix: Startup behavior of the OnOff cluster might be incorrect due to interactions with Level Control or Color Control clusters on the same application endpoint
• Bug-fix: Brightness adjustment of the Level control cluster might be incorrect due to interactions with a Color Control cluster on the same application endpoint
• Bug-fix: Under rare circumstances, neighbor table entries might be incorrect (caused by a typo)
• Bug-fix: Under rare circumstances, out-of-sequence or truncated OTA data block could result in failed OTA download attempts