Skip to end of metadata
Go to start of metadata

The RapidHA 1.5 version stream is now closed. MMB Networks recommends upgrading to RapidHA v1.7 to stay up to date with new feature releases, bug fixes and stability improvements.

This document is the primary developer specification and technical reference to the RapidHA Serial Protocol Version 1.5, a serial interface for exercising the RapidHA application framework. By building on existing ZigBee stack application frameworks, the RapidHA firmware has been designed to facilitate easy development of Home Automation (HA) applications.  

Whether you have an existing product or are designing a new one, the HA 1.2-certified RapidHA application framework significantly reduces development effort and time to market for your device. In typical integration scenarios, the RapidHA serial protocol command interface may be leveraged by a connected Host application to exercise the RapidHA firmware to perform complex ZigBee tasks. 

Design

RapidHA is a ZigBee HA 1.2 application developed by MMB Research, Inc. for our SiLabs EM357-based ZigBee platforms with support for external flash. The application may be exercised in the following ways:

  • By integrating a Host application via the RapidHA serial protocol
  • By using MMB's host-side Java Serial Libraries to aid in development on platforms that support it

The RapidHA application may be configured to serve as a ZigBee coordinator, router, or end device (non- sleepy, with sleepy functionality slated for later releases).

RapidHA offers additional ZigBee profile support beyond HA 1.2, including Control4 and Daintree ControlScope systems. The application supports specification-standardized cluster, attribute, command, and endpoint functionality. The Host may further define custom cluster, attribute, command, and endpoint support.

In short, RapidHA offers total flexibility for the integrating Host to define the desired device types, profiles and other supported ZigBee features and functionality. As of this writing, v1.2.0 is the fourth official release.

Definition of Terms and Acronyms

  • Host – Refers to the host device (i.e. the MCU or native intelligence of an integrating device), or the RapidHA Desktop application/Host simulation engine
  • Module – Refers to the module/radio package running the RapidHA application
  • ZCL – The ZigBee Cluster Library
  • HA – The Home Automation profile, specifically HA 1.2
  • CS – Checksum, 16 bits
  • LSB –Least significant byte of a value greater or equal to 2 bytes in length
  • MSB –Most significant byte of a value greater or equal to 2 bytes in length

Native Cluster Support 

RapidHA supports a number of Native Clusters for immediate configuration. 

  • “Activate” a Native Cluster with a single API command

  • The Cluster will spin up automatically

  • The Cluster will respond to mandatory commands as expected and will also automatically configure and populate all mandatory attributes

Currently supported Native Clusters are listed below. Note that the HA 1.2, iControl, Control4 and Daintree columns indicate whether the given cluster is typically mandatory, across a range of device types, for operation on those channels/profiles.


ClusterTypeHA 1.2iControlControl4Daintree ControlScope
BasicServer

IdentifyServer/Client
CommissioningServer


TimeServer/Client
Power ConfigurationServer

AlarmsServer

On/OffServer/Client
Level ControlServer/Client
ThermostatServer

Thermostat UI ConfigurationServer

Fan ControlServer

DoorlockServer
Poll ControlServer/Client

IAS ZoneServer

IAS ACEServer

IAS Warning DeviceServer

Ballast ConfigurationServer


GroupsServer/Client
ScenesServer/Client
OTA UpgradeServer/Client
DiagnosticsServer


Control4 Large Network SupportClient


References

For readers interested in specifications adhered to by RapidHA, please see the following:

  • ZigBee Home Automation Profile Specification for HA 1.2 (11-5474-49)
  • ZigBee Cluster Library Specification

The latest published profiles and specifications can be downloaded from the ZigBee Alliance website.

  • No labels