************************************************************************** Firmware Revision History - XBee/XBee-PRO Smart Energy Generic Module Radio Modems ************************************************************************** ** XBee-SE Firmware Overview ** The XBee-SE firmware is based off the EmberZNet 3.4.0 (beta 1) ZigBee-PRO stack. XBee-SE firmware uses the AT commands and API frames of XBee-ZB firmware, with some minor differences in default values and ranges. ** XBee-SE Firmware Versions ** XBee version numbers will have 4 significant digits. A version number is reported by issuing an ATVR command. The response returns 3 or 4 numbers. All numbers are hexadecimal and can have a range from 0-0xF. A version is reported as "ABCD". Digits ABC are the main release number and D is the revision number from the main release. "B" is a variant designator. The following variants exist in ZB firmware: • “1" - Coordinator, API Mode (AP=1,2) • “3" - Router API Mode (AP=1,2) All releases will have an even number for C. All internal development will have an odd number for C. Field D is always present, even when D is 0. ** Released Versions ** Released ZigBee firmware versions are available from the X-CTU program for download. To download released versions: 1. Go to the ‘Modem Configuration’ page in X-CTU. 2. Click on ‘Download New Versions’ and select ‘Web’. 3. You may need to disable your firewall in order to download new versions. ************************************************************************** * Version 3x19 Release Notes * ************************************************************************** Release Date: June 23rd 2009 ZigBee Stack: EmberZNet 3.4.0 ZigBee-PRO stack FEATURES - new source addresses are added to the address table to facilitate subsequent acceptance of APS encrypted packets NEW AT COMMANDS - NR, NR0 command added to disassociate local node from the network - PO command added to set polling rate on end devices; zero value invokes 100 msec delay, range is 1..x1770 in units of 10 msec (10msec:60sec), default is 0x09 (maps to 100 msec) BUG FIXES - End Devices leave the network after polls are not answered AND 5 seconds have elapsed without polls being answered - End Devices wake completely upon receiving a fragment - Broadcast messages which are too big to process no longer hang the coordinator and now return a 0x74 Tx Status message ************************************************************************** * Version 3x18 Release Notes * ************************************************************************** Release Date: June 4th 2009 ZigBee Stack: EmberZNet 3.4.0 ZigBee-PRO stack FEATURES - A new transmit status (0x26) for a non-failure status where an expected relay of a broadcast packet by a node's neighbors was not detected. - A new receive option bit (0x40) was added which indicates if the packet came from an end device. - Two speed end device polling. 7.5 seconds is the slow rate, which switches to the fast rate to transact with the parent, and back to slow when it is done. - In the transmit queue, getpendingtx gets the oldest entry instead of the next entry. - If a node discovers it has been orphaned by its parent, it now leaves and attempts to rejoin the net. - CTS is deasserted during authentication. NEW AT COMMANDS - A new command "PO" which sets the slow polling rate on the end device. BUG FIXES - Fixed a bug in packet tracking. - If the extended timeout option is enabled, then it is used because end devices need more time than routers to ack their packets. - A watchdog reset has been fixed which occurred when a source-route was used inappropriately. - A router/end device with no certificate no longer attempts to discover the key establishment cluster. - A coordinator now uses the correct destination endpoint value when responding to SE cluster requests. ************************************************************************** * Version 3x17 Release Notes * ************************************************************************** Release Date: June 2nd 2009 ZigBee Stack: EmberZNet 3.4.0 ZigBee-PRO stack FEATURES NEW AT COMMANDS BUG FIXES - APS Encryption and Fragmentation supports payloads of one to 128 bytes. ************************************************************************** * Version 3x16 Release Notes * ************************************************************************** Release Date: May 29th 2009 ZigBee Stack: EmberZNet 3.4.0 ZigBee-PRO stack FEATURES - Changed Modem descriptor from XB24-ZB, XBP24-ZB to XB24-SE, XBP24-SE respectively. - Using production release of Ember Stack 3.4.0. NEW AT COMMANDS BUG FIXES - A power reset no longer resets the Coordinator's Key Table. ************************************************************************** * Version 3x15 Release Notes * ************************************************************************** Release Date: May 27th 2009 ZigBee Stack: EmberZNet 3.4 (beta 3) ZigBee-PRO stack FEATURES - Key Establishment is now disabled on routers and end devices by default. To enable, set EO=8. KE is always enabled on Coordinators, EO=2. This was done to improve the "out-of-the-box" experience for developers who lack test or production certificates for their modems. To enable KE, set EO to 8: "7e 00 05 08 01 45 4f 08 5a" To disable KE, Set EO to 0: "7e 00 05 08 01 45 4f 00 62" NEW AT COMMANDS BUG FIXES - Corrected problem which generated a 0x74 status code (payload too big) when APS encryption was invoked for RF data payloads of 58-66 bytes. ************************************************************************** * Version 3x14 Release Notes * ************************************************************************** Release Date: May 15th 2009 ZigBee Stack: EmberZNet 3.4.12 (beta 2) ZigBee-PRO stack FEATURES - End Devices are supported in this release NEW AT COMMANDS BUG FIXES - End Device was unable to join the network as a child of the Coordinator. - Hardcoded endpoint value (instead of correct source endpoint value) was being used in generating KE responses. ************************************************************************** * Version 3x13 Release Notes * ************************************************************************** Release Date: April 1st 2009 ZigBee Stack: EmberZNet 3.4.0 (beta 1) ZigBee-PRO stack FEATURES - Fragmentation has been added. The maximum payload size is 128 bytes, supported by the transmission of up to three fragment packets. - SC mask default value has been changed to 0x3FFF. - Ability to disable authentication. For routers and end devices, change the EO setting from 8 (enables authentication) to 0 (disable authentication). NEW AT COMMANDS - VC: Verify certificate. Read-only. 1 = certificate present, 0 = no certificate present. BUG FIXES 1. Power cycling a router no longer causes it to perform key establishment. ************************************************************************** Known Issues ************************************************************************** The following are known issues in the SE hardware / software. ****** Compiler and Ember Stack ****** Both the compiler and stack are beta versions. We are awaiting a production release for both from Ember. ****** Simulated EEPROM Erases ****** The Ember ZigBee stack occasionally writes information to non-volatile memory. These writes may require performing a flash page erase which can block up to 20ms (worst case). The EM250 has a 4-byte FIFO to collect incoming serial data. However, if serial uart interrupts are disabled for 20ms, it is possible for incoming serial data to be dropped once the 4-byte FIFO filles. ZB firmware de-asserts CTS about 40 microseconds before an erase operation begins. The application should observe CTS flow control as quickly as possible to prevent data loss. Note that PCs often make use of a FIFO buffer where serial data can be buffered prior to transmission to the serial port. If FIFO buffers are used, PC applications will not be immediately responsive to CTS and may experience rare data loss.