Child pages
  • Managed Firmware Plugin
Skip to end of metadata
Go to start of metadata

For devices that read firmware updates from HTTP, TFTP or FTP directories, you can create a settings descriptor file that will be used to generate a web page to upload files for the device and deliver them to the appropriate directory.

Step 1:Declare upload specification

Add a new upload specification to any existing Spring bean file. For example

  <bean id="polycomFirmware"

    <!-- Use upload spring bean -->
    <constructor-arg value="upload"/>

    <!-- Directory to find upload.xml file -->
    <constructor-arg value="wayCool"/>

    <!-- Label -->
    <constructor-arg value="Way Cool Device"/>


Step 2:Describe upload files

Create following file

<?xml version="1.0"?>
<!DOCTYPE model PUBLIC "-//SIPFoundry//sipXconfig//Model specification 2.0//EN" 
  <group name="firmware">
    <description>Firmware for Way Cool Device</description>
    <setting name="wayCoolFirmware.dat">
      <description>Firmware binary.</description>

The group and setting names and labels are irrelevant, but pick meaningful values incase you need to process the settings.


  • You can write your own code to deliver or process the uploaded files. Extend, add an entry in Spring file similiar to Spring bean "upload". Change the first argument of the upload specification entry to your spring bean name.
  • Declare firmware, ring tones, dial plans, directories, etc, in your upload.xml file. Break into logical groups for better presentation in web UI.
  • To add support for multiple firmware versions, you can create a series of upload.xml files to organize and extend other versions, much like phone.xml and line.xml files. For example:

    upload.xml – all firmware files
    upload_3.x.xml – describe firmware files unique to version 3.x
    upload_4.x.xml – describe firmware files unique to version 4.x

and multiple upload specification entries in the spring file for 3.0 and 4.0


  • Phone and gateways will be able to select from a list of available upload entries. At minimum this will enable new setting for the device to show up based on that firmware version.
  • No labels