Updating the SmartServer using the SmartServer CMS with an Internet Connection

For SmartServer 3.3 and prior, see Updating using the SmartServer CMS (Release 3.3 and Prior)

You can update or upgrade your SmartServer IoT software to a newer release, if available.  An update is a release with the same release number plus "Update" in the name, for example, an update from SmartServer 3.6 to SmartServer 3.6 Update 2.  An upgrade is a release with a different release number, for example upgrading from SmartServer 3.4 to SmartServer 3.6.  An active SmartServer maintenance license is required to upgrade your SmartServer.  This is one of four methods of updating, upgrading, or re-imaging your SmartServer software as described in Updating or Re-imaging the SmartServer Software.  The method described on this page is the easiest if your SmartServer has an Internet connection.  You cannot use this method to downgrade to a prior version of the SmartServer.  To downgrade your SmartServer, re-image the SmartServer using the procedure in the Updating or Re-imaging the SmartServer with the SmartServer Console section.

You can define which version of software you want to upgrade the SmartServer to by specifying the update source in one of the following way (both methods require Internet access):

  • Internet – allows you to specify which version you want to update the SmartServer to from a CMS Devices widget dropdown list
  • Update Loader –  requires you to download the update loader and initiate the update process using the CMS Devices widget

You can optionally clear your SmartServer database prior to the update to prepare the SmartServer for a new installation. You will need to allow 10 minutes to initialize the SmartServer IoT. See Resetting the SmartServer IoT to Factory Defaults for more information.

If you are using Remote CMS, you can update multiple SmartServers at the same time so that they can operate at the same revision level using the methods described in this section.

This section consists of the following:

Using the Internet

To update the SmartServer using the Internet method for the update source, perform the following steps:

  1. SmartServer versions are hardware specific. See Determining SmartServer Software Version Compatibility before upgrading or downgrading to verify compatibility for your update.

  2. Prior to starting the update, if you are using any custom applications or services on the SmartServer, verify you have backup copies of your custom applications and services.  The update process will preserve custom applications and services that you have stored in the /var/apollo directory or one if its subdirectories such as /var/apollo/data/apps. If you perform an update and lose any custom applications or services, see the recovery procedure.

  3. To optionally monitor the progress of the update, connect to the SmartServer console as described in Connecting to the SmartServer Console and enter the top command at the console prompt.

  4. To optionally clear the SmartServer database prior to updating, follow the steps for Resetting to Defaults Using the Configuration Page (reseting the databases) in the Resetting the SmartServer IoT to Factory Defaults section. Allow 10 minutes to initialize the SmartServer IoT.

  5. Start the SmartServer CMS as described in Open the SmartServer IoT CMS.

  6. Open the Devices widget, Segment Controllers tab. Click the Expand button (  ). 



  7. Click the Action button () to the right of the SmartServer IoT device and select the Update action.



    Or, if you are using Remote CMS, you can update multiple SmartServers at the same time so that they can operate at the same revision level. Click the Action button () and select the Update SmartServers action.



    The Update Segment Controllers view appears.


    Local CMS


    Remote CMS

  8. Select Internet for the Update Source from the dropdown list.



  9. Select the update version from the list of available options using the Select a Version dropdown list.

  10. Click Update.

  11. If your selected update image requires an active maintenance license, the CMS will 1) display the error message "This image requires an active maintenance license for installation. Add a new maintenance license to extend the maintenance period for this SmartServer." and 2) open the Manage Licenses dialog allowing you to view the configured licenses as well as to a new maintenance license.  Activate a maintenance license before proceeding.

  12. The CMS downloads and installs the update image. If you started a console and entered the top command, you will see the following processes as the download and update installation progresses:

    • wget – displayed while the CMS downloads the update image
    • echloader – displayed while the CMS loads the update image
    • unzip – displayed while the CMS extracts the contents of the update image
    • mender – displayed after about 7 minutes while the CMS installs the update image

  13. After approximately 30 minutes the CMS displays "The system is going down for reboot...".  Wait an additional 5 minutes to allow the software update to complete and then start the CMS as described in Open the SmartServer IoT CMS. With SmartServer release 3.2 and higher, you can monitor the SmartServer Ready LED for system status. 

  14. Clear your browser cached data after the SmartServer is upgraded. For information on how to clear cached data, refer to the links below:

Using the Update Loader

To update the SmartServer using the Update Loader method for the update source, perform the following steps:

  1. SmartServer versions are hardware specific. See Determining SmartServer Software Version Compatibility before upgrading or downgrading to verify compatibility for your update.

  2. Download the update loader to your computer. Links to the update loaders are available at SmartServer Release Notes.  The latest update loader is available at the following location: 

    https://downloads.echelon.com/support/downloads/software/smartserver/iot/SmartServer_IoT.armv7l.glpo

  3. Verify that your data log size is less than 4 GB. If the data log exceeds 4 GB, then reduce the data log size by reducing your data retention times as described in Defining Datapoint Properties. Wait for the SmartServer to reduce the data log size below 4 GB before continuing to the next step.

    1. For SmartServer 3.4 and higher, use the SmartServer app bar Storage display to determine the SD Card usage. Storage reflects percentage used internal storage (stored in /var/apollo)  / percentage used SD Card storage (stored in /media/sdcard). Allow for a minimum 12.5% available space.

    2. For SmartServer 3.3 and prior, use the Storage widget as described in Managing the SmartServer SD Card (Release 3.3 and Prior) to determine the SD Card usage.

  4. To optionally monitor the progress of the update, connect to the SmartServer console as described in Connecting to the SmartServer Console and enter the top command at the console prompt.

  5. To optionally clear the SmartServer database prior to updating, follow the steps for Resetting to Defaults Using the Configuration Page (reseting the databases) in the Resetting the SmartServer IoT to Factory Defaults section. Allow 10 minutes to initialize the SmartServer IoT.

  6. Start the SmartServer CMS as described in Open the SmartServer IoT CMS.

  7. Open the Devices widget, SEGMENT CONTROLLERS tab. Click the Expand button ).  



  8. Click the Action button () to the right of the SmartServer IoT device and select the Update action.



    Or, if you are using Remote CMS, you can update multiple SmartServers at the same time so that they can operate at the same revision level. Click the Action button () and select the Update SmartServers action.



    The Update Segment Controllers view appears.


    Local CMS


    Remote CMS

  9. Verify that Update Loader is selected for the Update Source from the dropdown list.

  10. Drag the file that you downloaded in step 1 into the Drop new update loader here area, or select it by clicking the Drop new image file here area and browsing to your file.



  11. Click IMPORT FILES.

    A message appears indicating that the file is being loaded.



    Once the image is loaded, a view similar to the following appears:



  12. Click the Load button ().

    A message appears indicating that the file is being sent to the device.



  13. If your selected update image requires an active maintenance license, the CMS will 1) display the error message "This image requires an active maintenance license for installation. Add a new maintenance license to extend the maintenance period for this SmartServer." and 2) open the Manage Licenses dialog allowing you to view the configured licenses as well as to a new maintenance license.  Activate a maintenance license before proceeding.

  14. The CMS downloads and installs the update image. If you started a console and entered the top command, you will see the following processes as the download and update installation progresses:

    • wget – displayed while the CMS downloads the update image
    • echloader – displayed while the CMS loads the update image
    • unzip – displayed while the CMS extracts the contents of the update image
    • mender – displayed after about 7 minutes while the CMS installs the update image

  15. After approximately 30 minutes the CMS displays "The system is going down for reboot...".  Wait an additional 5 minutes to allow the software update to complete and then start the CMS as described in Open the SmartServer IoT CMS. With SmartServer release 3.2 and higher, you can monitor the SmartServer Ready LED for system status. 

  16. Clear your browser cached data after the SmartServer is upgraded. For information on how to clear cached data, refer to the links below: