Deploy OTA Artifact with Command-Line Arguments

Allxon OTA Services: Unmatched Flexibility in Deployments

In our previous articles, we explored the foundational aspects of using Allxon OTA Deployment. With Allxon Agent, the pre-defined deployment script (ota_deploy.sh) can run automatically to perform all necessary tasks. However, some scenarios demand a more flexible approach, such as input custom arguments or variables to tailor the script for different execution contexts.

The cutting-edge Allxon OTA now provides enhanced flexibility, allowing users to add command-line arguments to their Artifact deployments. This upgrade ensures the deployment process better mirrors real-world application scenarios, offering a more adaptable and user-friendly experience.

 

Back to top

What You Will Need 

  1. Edge devices running Allxon Agent version 3.12 or higher (update now external link icon
  2. Example OTA artifact capable of processing command-line arguments

πŸ’‘ TIpHow to update Allxon Agent 

1. Prepare Example OTA Artifact

To get started, we recommend using an example. Download the appropriate example artifact for your device platform, which is designed to handle command-line arguments. 

- Linux (ARM64)

- Windows (x86_64)

2. Upload OTA Artifact

Once your artifact has been prepared, get ready to upload it onto Allxon Portal. 

How to Upload OTA Artifacts:

  1. Enter Allxon Portal  and select the OTA icon on the left navigation pane to enter OTA Deployment Page.
  2. Click on the + Upload Artifact button on the top right to start the uploading process.


  3. Drag or select the artifact file that you want to upload, and the upload process will start automatically.
    deploy - 2 select file and uploading-gif-1

πŸ’‘ Note: Only artifacts generated by Allxon Artifact Toolkit can be supported here. Do not edit the file name of the artifact.

4. When the artifact upload is complete, a success message will pop up. Click on the Done button.

5. Your artifact will now appear in the artifact list with the Status to be "Uploaded."

πŸ’‘Tip:

The artifact display name is the same as the artifact file name. You can edit the display name by clicking on  "β€’β€’β€’". 

 

Back to top

3. Deploy OTA Artifact

The power of Allxon OTA artifact deployment lies in its ability to deploy mass artifacts to scattered Edge AI devices in a matter of minutes. 

How to Deploy Artifacts:

  1. Click the Deploy button on the far right of the artifact.
  2. First, select the device group you want to deploy on the left.  And then, select the devices in the selected group that appear on the right. Click Next to continue.
  3. On the Preview page, add a command-line argument suitable for the example artifact. This will demonstrate how the artifact processes command-line inputs.
  4. The argument being passed is structured as a Name-Value pair, making it easier to recognize and parse within the script. In this example, the script is set up to recognize and parse a single argument with the name "arg1".

Caution: On Windows systems, avoid using double quotation marks ("") in the Value field.

 4. Once deployment is successful, a deployment activity will be shown in Deployment Activities tab, with the Display Status to be Complete.  

5. Check the result: A file will be generated on the device's Desktop containing the "Hello World" string, which was entered in the Value field in Step 3.

- For Linux (ARM64):

- For Windows (x86_64):  

 

To explore more details about the example artifacts and learn how to test argument execution for generated artifacts using Allxon CLI, please visit the dedicated GitHub page:

Linux (ARM64)

Windows (x86_64)

 

Back to top