This view allows you to create new XBee profiles or load and edit existing ones.

An XBee profile is a snapshot of a specific radio firmware configuration, including firmware, setting values, file system and other configuration information. Profiles can be used later in XBee Studio or other Digi RF applications.

Create a new profile

This action allows you to create a new XBee profile from scratch following a guided wizard:

  1. Description.

    Enter a description of the profile or any note related to it—optional.

  2. XBee firmware.

    1. Select the XBee product and Firmware version the profile targets to.

    2. Select whether the profile should Flash radio firmware in the XBee device or not. If you check this option, you can choose one of the following flash options:

      1. Flash if firmware is different. Firmware is flashed in the device only if the firmware version that the device is running is different from the one specified in the profile.

      2. Flash always. Firmware is always flashed regardless of the version running on the device.

    3. If the selected product is an XBee Cellular and the firmware version supports updating the modem component, select whether the profile has to Attach Cellular modem firmware or not. Note that if you do not attach it, other Digi RF applications will not be able to update the Cellular modem component in case it is needed.

  3. Firmware settings.

    1. Choose and enter the value of the firmware settings you want to configure with the profile. Note that read-only settings cannot be added to the profile.

    2. Select whether the profile should Reset module to factory defaults before applying settings or not. This is useful if you want to make sure the device does not have any previous configuration.

  4. File system.

    1. Select whether the profile should Format existing file system or not. This is useful if you want to make sure the device does not have any previous file system when flashing the new one.

    2. Select whether the profile should Format a new file system or not. If you check this option, you have to select the folder that contains the file system to flash by clicking the Browse… button. After that, you will see the file system contents in the control below.

  5. Custom scripts.

    Select whether the profile should Use custom scripts for XBee Multi Programmer or not. This feature allows you to run a script/program before and/or after applying a profile to the target device using XBee Multi Programmer.

    This section is divided into two sections, one for the pre-processing script, and the other for the post-processing script. Depending on the script you want to run, or both, fill in the appropriate information on each section respectively. Each section contains fields to indicate:

    1. Script command. The command to execute. Use whatever scripting language you want, but make sure it can be used by the machine that applies the profile. For example, if the command to run is: python set_node_id.py, it is mandatory that the correct Python interpreter is installed and accessible in the machine that applies the profile.

    2. Script timeout. This is the maximum time XBee Multi Programmer should wait for the script to finalize its execution. When this time has passed, if the script has not finished, XBee Multi Programmer will assume your program got locked, and will stop the execution of the script returning a Timeout Exception. This parameter is specified in seconds, and its valid range of values goes from 1 to 36000 seconds (10 hours).

    3. Script folder (optional). This is a directory containing the script to be run and all of the resources it might need during its execution. It is not mandatory to attach any script to the profile, as long as it is accessible by the machine that applies the profile. To indicate the script/program to run, use one of the following:

      1. Attach the folder that contains the script to the profile. To do so, click the Browse button of the corresponding section. Select the complete folder that contains your script—this will be the execution path. It does not matter the number of files the script requires in order to run, as long as they are all included in the selected folder. If external resources are required by the script, make sure they are properly handled within your script, or include them in the same folder as your script so they are attached to the profile.

      2. Use absolute paths to call a script that already exists in the machine that will apply the profile. The first field of each section—the command—can be called using absolute paths. Bear in mind that such script needs to handle all paths in an absolute manner, as well. In this case, the execution path will be the path where the XBee Multi Programmer was installed.

Load a profile

This action allows you to load an existing XBee profile in order to inspect and/or modify it:

  1. Select the XBee profile to load from your computer (.xpro extension) and click Open.

  2. The Profile editor loads the profile information and displays it along the different tabs of the view:

    1. Description. Contains the configured profile description.

    2. XBee firmware. Displays the XBee product and firmware version of the firmware corresponding to the profile.

    3. Firmware settings. Contains the list of firmware settings configured for the profile.

    4. File system. If the profile contains a file system, this tab displays its structure.

    5. Custom scripts. If the profile contains pre or post scripts, this tab displays their commands, timeout and structure for each one.

You can modify any aspect of the XBee profile and save it by clicking the Save button, which has two options:

  • Save profile. Overwrites the loaded profile.

  • Save as new profile…​. Allows you to save a new profile with the changes made without modifying the loaded profile.