Overview

Over-the-Air (OtA) updates are finally here! This is our first full stack feature, from bootloader to Meadow.Cloud. To get OtA working you need to first provision your device. Then, you need to package an application that enables the Update Service and upload it to Meadow.Cloud. Finally, you can publish your package to be received by your devices.

Provision Device

First, you need to register your device on Meadow.Cloud.

• Visit https://www.meadowcloud.co to setup your Meadow.Cloud account.
• Connect your Meadow device.
• Ensure you are signed in to Meadow.Cloud for command-line use. Via Meadow.CLI, run: meadow cloud login. This will launch a web browser to sign in to Wilderness Labs with the account you set up for Meadow.Cloud.
• Via Meadow.CLI, run: meadow device provision. This will take a couple minutes to complete. Visit to https://www.meadowcloud.co/devices to verify your device was successfully added.

Enable Update Service in Meadow.Core

By default, OtA is not enabled. Follow the steps to enable OtA in your application.

1. In app.config.yaml, add the following:

    Update:
      Enabled: true
   

   • (Optional) To see more detailed output, enable trace logging by adding the following lines in app.config.yaml:

       Logging:
         LogLevel:
             Default: "Trace"
     

2. Next, add event handlers for downloading and applying the updates.

    using Meadow.Update;
    ...
    public override async Task Run()
    {
        var svc = Resolver.Services.Get<IUpdateService>() as Meadow.Update.UpdateService;
        svc.ClearUpdates(); // uncomment to clear persisted info
   
        svc.OnUpdateAvailable += (updateService, info) =>
        {
            Resolver.Log.Info("Update available!");
   
            // queue it for retreival "later"
            Task.Run(async () =>
            {
                await Task.Delay(5000);
                updateService.RetrieveUpdate(info);
            });
        };
   
        svc.OnUpdateRetrieved += (updateService, info) =>
        {
            Resolver.Log.Info("Update retrieved!");
   
            Task.Run(async () =>
            {
                await Task.Delay(5000);
                updateService.ApplyUpdate(info);
            });
        };
   
        ...
   
    }
   

   This code adds event handers to download the new package, updateService.RetrieveUpdate(info);. and send the new file(s) to the bootloader, updateService.ApplyUpdate(info);

MPAK Creation

An .mpak file is a bundle that includes application and OS files. We’ll use the application we created in the previous section.

• Deploy the OtA-enabled application to a device. (Currently, the linker only runs during a deployment. This step can be skipped once this gets fixed.)
• Run meadow package create -p your_app_folder/bin/Debug/netstandard2.1/postlink_bin -v 0.9.8.1. This creates a .mpak file with the contents of your application and binaries for the OS version specified.
• To upload your newly created .mpak to Meadow.Cloud, run meadow package upload -p your_package_id. Visit https://www.meadowcloud.co/packages to verify your package was successfully uploaded.

Publish

• To publish via CLI, run meadow package publish -p your_package_id.
• To publish via Web, go to https://www.meadowcloud.co/packages and click Publish.

 

---

These docs are open source. If you find an issue, please file a bug, or send us a pull request. And if you want to contribute, we'd love that too!