This guide will explain how to port your existing firmware from deploythefleet.io to the new service at deploythefleet.com. An overview of the changes can be found here.

Overview

Currently your firmware has OTA logic that points it to the legacy Deploy the Fleet OTA service. This means it will connect to endpoints for that service to request updates. The new service is hosted on a different set of endpoints which your firmware will need to use for updates.

The general flow of porting your firmware looks like this:

  1. Modify your existing firmware to use the new Deploy the Fleet libraries.
  2. Upload modified firmware to the existing service and mark it as the default.
  3. As devices get the update they will start to connect to the new service and will show up on the Devices page for your product in the new account.
  4. All new updates should be created as Deployments in the new Management Console.

Porting Instructions

If you would like your existing product list migrated to the new service, simply request it from the existing app.

Request Migration

For your firmware, the specific change you need to make will depend on how your project is currently configured. Each scenario is covered below. Simply click on the scenario that applies to your firmware.

IMPORTANT: Regardless of which DTF library you are using, you MUST update to a 2.x version as the endpoints for updates have all changed.

DTF_ESP8266Update

Be sure to install a 2.x version of DTF_ESP8266Update.

The API for the library is mostly unchanged. The key difference is that you no longer pass the full product update URL to the call to DTF_ESP8266Update::getFirmwareUpdate. Instead you only pass the product id which can be found on the Settings tab of the new console.

Simply pass this as the first argument. All other arguments to this function have remained the same.

DTF_ESP32Update

Be sure to install a 2.x version of DTF_ESP32Update.

The API for the library is mostly unchanged. The key difference is that you no longer pass the full product update URL to the call to DTF_ESP32Update::getFirmwareUpdate. Instead you only pass the product id which can be found on the Settings tab of the new console.

Simply pass this as the first argument. All other arguments to this function have remained the same.

Native SDK for IDF

You will need to update the Deploy the Fleet SDK component of your project to a 2.x version of the library. This is easily accomplished by running the following command from the root of your project.

git submodule update --recursive

The API is unchanged for the native SDK so there are no code changes required. Simply rebuild your firmware and the binary is ready to be uploaded to the existing service.

FAQ

Does the new service still support failover?

Yes! All of the libraries support a failover update endpoint. If a device has not been updated in a while and no longer has a valid cert chain to the primary OTA service it should still be able to get an update.

What if I can’t get all of my devices to update and point to the new service?

Don’t worry, the legacy deploythefleet.io service will be online and supported through July 31, 2026 so you have plenty of time to get the devices updated and communicate with your customers. If you have extenuating circumstances and need more time beyond the planned shutdown date, please reach out to support@deploythefleet.com.

Updated: