v 2.2.2

Release Date: 2022-05-05 (May 05, 2022)

This release focuses on 

Release Notes

• Default Response of NO_IMAGE_AVAILABLE should be sent if ImageBlockRequest is received when no image on the server

v 2.2.1

Release Date: 2022-03-29 (March 29, 2022)

This release focuses on 

Release Notes

•  Device Event Add on a coordinator during startup will be delayed until the network is up

  • This caused issues on fresh boards as the coordinator's node id is not set until the network is up. 

  • Clients would have had to both listen for the network-up event AND device event add which caused some confusion and erroneous behavior.

v 2.2.0

Release Date: 2022-02-18 (February 18, 2022)

This release focuses on adding Poll Control Support To Device's with Poll Control Server

Release Notes

•  Add new Poll Control Manager To Support Adding ZCL/ZDO Unicasts Messages To A Device Specific Queue

  • If device has poll control server, poll control manager will attempt to first send the unicast to the device on failure, via aps ack timeout, or response received timeout (depending options)

    • On failure, a message will be added to a queue to be sent on a check-in from the device

    • The default behaviour can be modified to always add to the message queue without first sending out the unicast to target end device

  • On check-in, a check-in-response will be triggered using a configurable default fast poll timeout value

  • Added ability to automatically stop fast polling when no more tasks are in the queue

• Add poll control events API for clients to listen for when a device has started fast polling and when it has stopped

• Add new API in GatewayClient to read network status

v 2.1.2

Release Date: 2021-11-12 (September 10, 2021)

This release focuses on adding Install Code and Trust Center Network Features

Release Notes

• Cluster Revision Attribute for Poll Control Client and Diagnostics Client will be written to a value of 0x0003 on startup

v 2.1.1

Release Date: 2021-09-10 (September 10, 2021)

This release focuses on adding Install Code and Trust Center Network Features

Release Notes

• Network Formation Will Correctly Be The Default Network Method At Startup

• Cluster Revision Attributes For Basic, Identify, Alarms, Door Lock and Power client cluster will automatically be written

• Fix issue with ZCL Passthrough Message JSON From Throwing Exception When Deserializing Using toJSON() Method

• Fix ping() (latency request) method json 
  
  

  • Flatten object

v 2.1.0

Release Date: 2021-08-16 (August 16, 2021)

This release focuses on adding Install Code and Trust Center Network Features

Release Notes

• Expose More Information In Upgrade Progress for OTA and Serial Upgrades

  • upgradeFile

  • firmwareVersion

  • gatewayDeviceId

  • eventId

  • timestamp

• Add Install Code API

• Network Formation Used Over HA1.2 Form Network

• Add Network Formation API

• Network Steering Used When Joining For Devices

• Add Network Steering API

• Add Parameters to specify PanID and ExtendedPanId in HA1.2 Form Network

• Add Permit Join, PanID, and ExtendedPanId to network information

Internal Fix

• Extended PanID was not showing correct length of invalid valid when Dialogue failed

v 2.0.16

Release Date: 2021-04-09 (April 09, 2021)

This release focuses on internal development changes.

Release Notes

Internal Development Changes

• Add TestHarness API to facilitate automatic pre-release checks

  • Allows TestSuites using the TestHarness to specify devices on the local machine to setup a network and run tests with actual devices

• Add ProtocolPassThroughAPI PreRelease Test

• FunctionResult class will no longer have a global public variable for results

• Fix SpotBug warnings with OTA Upgrade Module

• Fix Timer Usages in OTA Upgrade

v 2.0.15

Release Date: 2021-03-25 (March 25, 2021)

This release focuses on more stability fixes for OTA Upgrade, adding more test coverages, and refactoring internal classes into appropriate modules.

Release Notes

Public API

• Add More Documentation To ZCL Unicast, Broadcast, and Multicast Methods That Matches The External Documentation On Confluence.

• Fix Issue of usage of FunctionObject interpreting integers as double for ZCL Unicast, Multicast and Broadcast.

• Fix unintended exception being thrown when using ConfigureReportingFunctionParameter to configure reporting.

• Fix OTA Upgrade Edge Case of Set OTA Upgrade Delay, Wait, Pause, Wait, and Unpause during mid upgrade. The OTA upgrade will now proceed as normal.

Internal Development Changes

• Refactored Usages of ZigBee Global class in zigbee-spec to add more convenience methods for converting to native zigbee types

  • Removed redundant objects

• Add More coverage for edge cases to the InternalOtaHandler

v 2.0.14

Release Date: 2021-02-26 (February 26, 2021)

This release focuses on more stability fixes for OTA Upgrade, adding more test coverages, and refactoring internal classes into appropriate modules.

Release Notes

Public API

• Fix issue where if a client were to send an image notify with no OTA file registered, all following image notifies would have been ignored.

• Fix issue of one-time delay being ignored if unpauseOtaUpgrade() is called immediately after SetRateLimitPolicy().

• Fix issue where two abort progress reports are observed when OTA server is brought down mid upgrade, and immediately brought back up.

Internal Development Changes

• Add more test coverage for ZCLAttributeWriteHandler in rapidconnectdevice module.

• Move ZCL Utilities and ZigBee ZCL classes from rapidconnectdevice module to zigbee-spec module.

• Remove dependency of rapidconnectdevice module from zigbee-spec.

• Add new API to internal FunctionResult class to start using actual Java objects instead of marshalling/unmarshalling JSON strings to facilitate device interactions internally. 

v 2.0.13

Release Date: 2021-02-05 (February 05, 2021)

This release is an internal maintenance release meant to facilitate upgrading aging test dependencies (JUNIT4). This change affects the entire rotarran-framework

Release Notes

• Remove JUNIT4 as a dependency in place of JUNIT5 (5.7.0)

• Upgraded Mockito from 2.23 to 3.7.7

• Modified every unit test, and integration test to use JUNIT5 API annotations and API

• Modified how integration and unit test reports are generated in GAPI

  • Build plan had to change to accommodate this change

  • Unit test results that are tested on the enterprise board will be created under the following path:

    • ../unit_test_results/TEST-junit-jupiter.xml

  • Integration test results that are tested on the enterprise board will be created under the following path:

    • ../integration_test_results/TEST-junit-jupiter.xml

  • JUNIT5 Test results will still output an XML file based on the legacy JUNIT XML format

    • https://confluence.atlassian.com/bamboo/junit-parsing-in-bamboo-289277357.html

• Add more unit tests to be tested on the enterprise board environment

• OTA Pause or Rate Limit Policy will now correctly be applied in edge cases where it is followed immediately right before a startOTAUprade():

v 2.0.12

Release Date: 2020-12-22 (Dec 22, 2020)

This release is an internal maintenance release

For more information regarding new and modified methods, see the API Documentation.

Release Notes

• Change Write Attributes to use ZCL Unicast instead of using RHAZCLWriteAttributeRequest

  • ManufacturerCode is now used automatically

• Fixed Issue when stopping OTAUpgrade, the upgrade will start again in the next QueryNextImageRequest

• Fixed Issue where if AllowAllUpgrades flag is false, and if end device does not hear ImageNotify, it will go ahead with an OTA upgrade on the next QueryNextImage

  • If we do not receive a response to ImageNotify, then we consider that upgrade "Cancelled"

• Update Abort Mechanism to abort with ImageBlockResponse instead of a DefaultResponse

  • ImageBlockResponse will contain the status of 95 as the payload as per spec

• Fix Internal FunctionObject JSON Serialization

• Add Access Control to Property.toString() method

v 2.0.11

Release Date: 2020-11-27 (Nov 27, 2020)

This release is a maintenance release meant to fix bugs.

For more information regarding new and modified methods, see the API Documentation.

Release Notes

• SimpleCli Bind and Unbind commands will not throw a more meaningful error on an incorrect payload

• Added Move To Level With Transition Time Functionality In LightDevice

  • SimpleCli will now have a new command "moveToLevelTransition"

• Logging Behaviour Modified

  • The Gateway API will no longer generate logs files by default, even if clients have their own logging configuration

    • To enable the Gateway API to generate log files on its own, the environment variable 'GAPI_DEBUG_FILE' must be present

  • Rolling Logs generated by the Gateway API will be reduced to a total of 20MB and only allowed to have a history of 1.

  • Gateway API has the capabilities to log to a Syslog daemon on the localhost via port 514 for Linux hosts 

    • This can be turned on via defining the environment variable 'GAPI_SYSLOG'

v 2.0.10

Release Date: 2020-06-22 (June 22, 2020)

This release is a maintenance release meant to fix bugs.

For more information regarding new and modified methods, see the API Documentation.

Release Notes

• Fixed Thermostat properties from not being updated (KeypadLockout TemperatureDisplayMode, TemperatureSetpointHold, and FanModeSequence)

• Some property names had inconsistent naming scheme from the rest of the properties which causes confusion amongst clients

• Door locks, especially ones with the WWAHU cluster, can now discover its properties

• Send ZCL Command caused issues in simple cli due to missing validation for the "Is Cluster Specific?" prompt

• JSSC will no longer throw IO Exceptions into the console needlessly as it causes confusion in the simple cli, especially on gateway devices

v 2.0.9

Release Date: 2020-06-05 (June 5, 2020)

This release introduces an OTA Upgrade server implementation, so that remote devices on the network (that have an OTA Client cluster) can be upgraded over-the-air.

For more information regarding new and modified methods, see the API Documentation.

Release Notes

• Added Groups API to facilitate groups management of Gateway Devices

• Added a new OTA Rate Limit Policy API

  • Pause/Unpause OTA upgrades

  • Slow down OTA upgrades

  • Speed up OTA upgrades

• Added new and optional GatewayClientBuilder to facilitate construction of a GatewayClient object 

• Added a new RapidConnect Passthrough Mechanism

  • A client can now register listeners to consume sent Rapidconnect frame events

  • A client can now register listeners to consume received  RapidConnect frame events

  • A client can now send raw RapidConnect frames from a gateway object

• OTA API Improvements

  • Fixes edge cases when registering OTA FIles and Handlers moments after GatewayClient has been initialized

  • OTA Progress handlers will now be called on a separate thread

• Various Bug Fixes

  • ping() method now returns a timeout correctly if devices go beyond the internal timeout

  • Can No longer register duplicate OTA Files

v 2.0.8

Release Date: 2020-02-21

This release introduces an OTA Upgrade server implementation, so that remote devices on the network (that have an OTA Client cluster) can be upgraded over-the-air.

For more information regarding new and modified methods, see the API Documentation.

Release Notes

• Added an OTA Server API, allowing users to register/deregister OTA upgrade files to be served over the network, start/stop OTA upgrades on remote devices, and monitor their progress.

• Added ZigbeeDevice API to multicast and broadcast protocol commands.

• Simplified the API by removing the "Status" class; has been merged with the UpgradeStatus class for clarity

• Various other stability and reliability improvements.

v 2.0.7

Release Date: 2019-12-06

This release focuses on stability and reliability improvements.

Release Notes

• Simplified the API by removing the CommandData class, which was no longer necessary.

• Changed ZigbeeDevice.sendZclCommand to specify whether the command requires a response. This flag should be set to avoid errors when sending commands that don't have responses.

• Fixed issues with Property Update handler not triggering on all possible zigbee attributes.

• Fixed issue with OnOff property showing that it was not writable.

• Fixed issue with ZigbeeDevice.sendZclCommand not setting the Manufacturer Code properly, if a non-zero value was passed in.

• Fixed reliability issues when reading many attributes from a single device at once.

• Fixed some display issues with various zigbee enumeration values not showing up correctly in Property objects.

• Added OSGI metadata into the bundle, for use in frameworks such as Eclipse Smart Home or Eclipse Kura.

• Removed unnecessary methods and classes.

• Various other stability and reliability improvements.

v 2.0.6

Release Date: 2019-10-23

This release focuses on performance improvements and bug fixes.

Release Notes

• Improved the performance of the serial port handling code on Linux and macOS by properly blocking when waiting for bytes. This noticeably improves overall system performance on single core CPUs.

• Fixed issues when configuring attribute reporting on devices whose properties haven't been discovered yet.

• Fixed issues with duplicate Property names. Property names that are derived from zigbee attributes names now have unique values. See Zigbee Attribute Names for updated names.