Schedule and run gateway firmware update task

Go to the Gateways hub page of the AWS IoT console and choose the gateway for which you're retrieving this information.

Go to the Firmware tab in the details page of the gateway to see the current firmware version and the status information that indicates whether a firmware update is pending.

Obtain wireless gateway ID

First, obtain the unique identifier of the gateway for which you want to retrieve the current firmware version. If you've already provisioned a gateway, you can get information about the gateway using the GetWirelessGateway API operation or the get-wireless-gateway CLI command.

aws iotwireless get-wireless-gateway \ 
    --identifier 5a11b0a85a11b0a8 \ 
        --identifier-type GatewayEui

Following shows a sample output for the command.

{
    "Name": "Raspberry pi",
    "Id": "1352172b-0602-4b40-896f-54da9ed16b57",
    "Description": "Raspberry pi",
    "LoRaWAN": {
        "GatewayEui": "5a11b0a85a11b0a8",
        "RfRegion": "US915"
    },
    "Arn": "arn:aws:iotwireless:us-east-1:231894231068:WirelessGateway/1352172b-0602-4b40-896f-54da9ed16b57"
}

Get gateway firmware version

Using the wireless gateway ID reported by the get-wireless-gateway command, you can use the get-wireless-gateway-firmware-information command to get the CurrentVersion.

aws iotwireless get-wireless-gateway-firmware-information \
    --id "3039b406-5cc9-4307-925b-9948c63da25b"

Following shows a sample output for the command, with information from all three fields displayed by the CurrentVersion.

{
    "LoRaWAN": {
        "CurrentVersion": {
            "PackageVersion": "1.0.0",
            "Model": "rpi",
            "Station": "2.0.5(rpi/std) 2021-03-09 03:45:09"
        }
    }
}

Go to the Gateways hub page of the AWS IoT console and choose the gateway for which you're updating the firmware.

Go to the Firmware tab in the details page of the gateway and choose Update firmware.

Create a wireless gateway task, or choose an existing task definition if you have already created one.

If you have already created a task definition, choose Use an existing task. Information about the task definition will appear here, such as the Package version, the location for the firmware file in Amazon S3, and the status of the update. You can review the information and then choose Update firmware.

Specify firmware file and location in Amazon S3

You can use an Amazon Simple Storage Service bucket to store the firmware update files. Specify the location to your firmware file in Amazon S3, and provide the IAM role that grants AWS IoT Core for LoRaWAN permission to access the file and perform the update.

(Optional) Provide additional firmware verification settings

Optionally, if your firmware update was signed, you can use the additional settings to specify the update signature and CRC. These settings can be used to verify the authenticity and integrity of the signed update. It also ensures that the code was not corrupted or altered, and the devices run code that's published only by trusted authors. The update signature and CRC will be passed to AWS IoT Core for LoRaWAN when updating the firmware using CUPS.

(Optional) Provide additional setting to automatically create update tasks

Optionally, we recommend that you choose to specify automatic creation of tasks for all gateways by using the Auto create tasks and update all like gateways parameter. This parameter applies to any gateway that has a match for all three parameters mentioned previously in What's a wireless gateway task definition?. If this parameter is disabled, the parameters have to be manually assigned to the gateway.

Permissions to access the bucket

You can either create a new service role or choose an existing role to allow AWS IoT Core for LoRaWAN to access the firmware update file in the Amazon S3 bucket on your behalf.

To create a new role, you can enter a role name or leave it blank for a random name to be generated automatically. To view the policy permissions that grant access to the Amazon S3 bucket, choose View policy permissions.

Specify the input parameters for the update task

Create a file, input.json, that'll contain the information to pass to the CreateWirelessGatewayTaskDefinition API. In the input.json file, provide the following information that you obtained earlier:

Create the gateway task definition

Pass the input.json file to the create-wireless-gateway-task-definition command to create the task definition.

aws iotwireless create-wireless-gateway-task-definition \ 
    --cli-input-json file://input.json

Following shows the output of the command.

{
    "Id": "4ac46ff4-efc5-44fd-9def-e8517077bb12",
    "Arn": "arn:aws:iotwireless:us-east-1:231894231068:WirelessGatewayTaskDefinition/4ac46ff4-efc5-44fd-9def-e8517077bb12"
}