This page describes the commands supported by the RapidConnect serial protocol.
Serial Protocol commands are sent between the Host application and MMB Networks Module. The commands are then translated into Zigbee commands by the Module Firmware
If you are new to the RapidConnect Serial Protocol, get started by reviewing the Serial Protocol Overview guide.
Sleep Consultant Packages
Serial Protocol Overview
Serial Protocol overview and architecture guide.
Zigbee Specification References
Provides useful zigbee specification reference data such as Data Types, Status Codes and Zigbee Device ID's.
(0x55) Utility Frames
This section describes a wide range of command functionality that works on a system-wide level under the Primary Header 0x55.
( PH:0x55 SH:0x00 ) - Reset Command
Overview
(0x01) Network Commissioning Frames
The Network Commissioning command set allows the Host to prompt the Module to either form a network or join an existing network.
Updates to the Zigbee 3.0 Commissioning mechanism have been incorporated into RapidConnect v3.5.0 and above. Network Steering is now the preferred method of joining a new network, while the Network Formation command is used when forming new networks.
(0x02) Security Configuration Frames
This section describes commands that set and report on security keys.
( PH:0x02, SH:0x03 ) - Install Code Request Command
Overview
(0x03) ZigBee Support Configuration Frames
This section describes the commands used to configure RapidConnect IEEE functional device type, as well as the endpoints, clusters and attributes that will logically exist on that device.
( PH:0x03, SH:0x00 ) - Device Type Write Command
Overview
(0x04) ZDO Message Frames
This section describes the two ways, unicast and broadcast, for the Host to send a ZDO command. It also describes the commands sent by the Module to communicate ZDO-level information to the Host.
( PH:0x04, SH:0x01 ) - Send ZDO Unicast Command
Overview
(0x05) ZCL Message Frames
( PH:0x05, SH:0x00 ) - Send ZCL Unicast Command
Overview
The Send ZCL Unicast command is sent by the Host to the Module in order to transmit a custom ZCL message to a target node. The command provides facilities for configuring the Encryption Level of the message, either with Network or Network + APS Encryption, as well as available Response Options, including custom sequence numbers, requiring an APS ACK or enabling processing of a corresponding response with a matching transaction sequence number.
(0x11) General Cluster Frames
The General Clusters command set encompasses the following mandatory ZCL clusters in the general domain:
- Basic
- Identify
(0x12) HA Clusters
The HA clusters command set encompasses the following ZCL clusters for common HA applications:
- On/Off
- Level Control
(0x0B) Serial Bootload Frames
The commands in this section facilitate serial bootload upgrade of the application operating on the Module. These commands have been implemented per HA 1.2 guidelines.
(PH:0x0B, SH:0x01) - Trigger Bootloader Request Command
Overview
(0x0B) OTA Upgrade Client Frames
The commands in this section facilitate over-the-air (OTA) client of the application operating on the Module. These commands have been implemented per the ZigBee HA 1.2 guidelines.
( PH:0x0B, SH:0x20 ) - OTA Query Configuration Request Command
Overview
(0xB0) OTA Upgrade Server Frames
The commands in this section facilitate over the air (OTA) server of the application operating on the Module. These commands have been implemented per the ZigBee HA 1.2 guidelines.
( PH:0xB0, SH:0x00 ) - OTA Image Notification Command
Overview
(0xD1) Diagnostic Frames
This section describes the commands that initiate and respond to network scans.
( PH:0xD1, SH:0x00 ) - Network Scan Request Command
Overview
(0xDF) Manufacturing Library Frames
Manufacturing Library Start - ( PH:0xDF, SH:0x80 )
Overview
Manufacturing Library Start is sent from the Host to the Module to enable Manufacturing Library functions. The Host must send this frame before using other manufacturing library frames.
Change Log
Frames Removed:
- Trust Center Install Code Request
- Trust Center Install Code Response
- Bootloader Version Request
- Bootloader Version Response
Updates to Existing Frames:
- Module Info Response - Application Info enumerations modified
- Module Info Response - Hardware Type field renamed to Hardware Version
- Module Info Response - Hardware Version enumerations modified
- Module Info Response - Bootloader Type enumerations modified
- Status Response - Added MMB Unrecognized Command (0x13) to enumerations
- Trust Center Security Policy Write - Added Incorrect Length (0x07) to Status Response enumerations
- Trust Center Key Exchange Update - Key Exchange status enumerations expanded
Frames added for Zigbee 3.0:
- Trust Center Security Policy Write
- Trust Center Security Policy Request
- Trust Center Security Policy Response
- Trust Center Key Exchange Status Update
- Trust Center Removed Device Notification
- Trust Center Install Code Add
- Trust Center Install Code Request
- Trust Center Install Code Response
- Clear Trust Center Install Codes
- Trust Center Install Code Max Count Request
- Trust Center Install Code Max Count Response
Updates to existing frames to support BSB03PA1x modules:
- Module Info Response - Hardware Type enumerations modified to include 0x05 = EFR32MG1B232F256GM32
- Module Info Response - Bootloader Type enumerations modified to include 0x02 = Gecko Standalone Bootloader