XBee firmware filename conventions

XBee firmware files use the following filename convention:

X_ABCDE_Y.EXT

• X is the radio hardware and network type. The possible radio hardware and network type values are follows:

  X value in filename	Radio hardware and network type
  XB24_15_4	XBee 802.15.4
  XBP24_15_4	XBee PRO 802.15.4
  xb24-dm	XBee DigiMesh 2.4 GHz
  xbp24-dm	XBee PRO DigiMesh 2.4 GHz
  XB24-B_ZigBee	XBee ZNet 2.5
  XBP24-B_ZigBee	XBee PRO ZNet 2.5
  XB24-ZB	XBee ZB
  XBP24-ZB	XBee PRO ZB
  XB24-SE	XBee Smart Energy
  XB3-	XBee3
  XBP24-SE	XBee PRO Smart Energy
  XBP08-DP	XBee PRO 868 MHz
  XBP09-DP	XBee PRO 900 MHz
  XBP09-DM	XBee PRO DigiMesh 900 MHz
  xb24c-zb	XBee ZB on S2C
  xbp24c-zb	XBee PRO ZB on S2C
  xb24c-se	XBee Smart Energy on S2C
  xbp24c-se	XBee PRO Smart Energy on S2C

• ABCDE is the full version number in hexadecimal.

  • A is the region. A is 0 if only 4 digits are present. The possible region values are follows:

    A value in filename	Region
    0	US, World, or ETSI
    1	Japan high power 2.4 GHz
    2	Australia 900 MHz

  • B is the network type. The possible network type values are follows:

    B value in filename	Network type
    1	802.15.4, ZNet 2.5, 868 MHz, or 900 MHz
    2	ZB
    3	Smart Energy
    4	ZB on S2C
    5	Smart Energy on S2C
    8	DigiMesh

  • C is the node type.

    In the following table, API mode is a frame-based interface mode that extends the level to which a host application can interact with the networking capabilities of the module. When in API mode, all data entering and leaving the module is contained in frames that define operations or events within the module. Gateways typically use XBee firmware for coordinator API mode. More information about API mode is in the user manuals for the XBee RF modules.

    AT mode is a state in which incoming serial characters are interpreted as XBee AT commands. More information about AT mode is in the Product Manuals for the XBee RF modules.

    ZigBee nodes use different firmware for AT and API mode. Standard nodes support both AT and API modes.

    The gateway radio must be ZigBee type 1 or 3, or non-ZigBee type 0.

    Remote nodes can use any node type.

    The possible node type values are follows:

    C value in filename	Node type
    For ZigBee radios (ZNet, ZB, SE):
    0	Coordinator AT command mode
    1	Coordinator API mode
    2	Router AT mode
    3	Router API mode
    4	Router/End Device Sensor Adapter
    5	End Device Power Harvester Adapter
    6	Router/End Device Analog I/O Adapter
    7	Router/End Device Digital I/O Adapter
    8	End Device AT command mode
    9	End Device API mode
    x	Multiple node types in a zip file
    Node type values for other radios:
    0	Standard node
    1	XBee RS-232 Adapter
    2	XBee Sensor Adapter (also known as One-wire Sensor)
    3	XBee RS-485 Adapter
    4	XBee USB Adapter
    5	RS-232 Power Harvester Adapter
    6	Analog I/O Adapter
    7	Digital I/O Adapter
    x	Multiple node types in a zip file

  • D is the major revision number.
  • E is the minor revision number.

• Y is the radio type modifier. _Y indicates a variation of X and may not be present. The possible radio type modifier values are follows:

  Y value in filename	Radio type modifier value
  S2B	XBee PRO S2B

• EXT is the filename extension, designating the file type. The extension .ebl is for ZigBee nodes (ZNet, ZB, or SE). The extension .oem is for all other node types.

  .EXT value in filename	File type
  ebl	ZigBee radio firmware (ZNet, ZB, or SE)
  oem	XBee module firmware for all other XBee module types
  hex	Hexadecimal-encoded firmware
  ehx	Encrypted hexadecimal firmware
  mxi	XBee module parameter information
  zip	Archive of above files
  ota	XBee3 radio firmware
  otb	XBee3 radio firmware

  You can update the gateway radio with .ebl or .oem files.

  You can update ZB remote nodes over the air with .ebl files. On gateways supporting XBee 3 OTA updates, files with the extensions .ota and .otb are allowed.

  XCTU uses .hex, .ehx, .mxi, and .zip files.

  XCTU can create .oem files from .ehx files.

For example, file XBP24-ZB_2164.ebl is the XBee-PRO ZB coordinator API firmware. You can use this firmware file to update the XBee RF module in the gateway. Details about the conventions follow.

Currently, ConnectPort X gateways support these XBee firmware versions:

XBee module model type in gateway	Supported firmware versions
XBee ZB	Version 2x21 or greater
XBee 802.15.4	Version 1080 or greater
XBee DigiMesh 900 MHz	Any firmware version
XBee DigiMesh 2.4	Version 8040 or greater
XBee Smart Energy (SE)	Any firmware version
XBee DigiMesh 868 MHz	Any firmware version
XBee ZB on S2C	Any firmware version
XBee Smart Energy on S2C	Any firmware version