Prepare EdgePackage

Deploy EdgePackage is a more powerful feature than deploy script. It’s not limited to deploying scripts to devices, but can also include other files such as images, executables, and model weight files.

The package itself has a specified format:

my_EdgePackage_1.zip
├── config.yaml
├── my_module_1.zip
│   ├── config.yaml
│   ├── script_1.sh
│   ├── script_2.sh
│   └── ...(optional files such as images, executables, models, etc.)

Package Structure

The following configuration examples demonstrate a use case for copying expert image to a specified location on target devices.

First Level config.yaml Format

The first level config.yaml describes what this package contains and provides metadata about the overall deployment package.

---
name: Copy File
version: 1.0.0
description: Demo Copy File
file_type: .zip #fixed to .zip, will be deprecated in the future
created_date: 2025-06-02

module:
  module_1:
    name: Copy Expert Image
    module_path: ./copy_expert_image.zip
    os: Linux # <Linux|Windows> 
    device: # target device if specified, leave blank for normal deployment
      -

Second Level config.yaml Format

The second level config.yaml is the main body of the package that gets deployed to the target devices, containing the actual execution details and scripts.

---
name: copy expert image
version: 1.0.0
description: copy expert image to desktop directory
file_type: .zip #fixed to .zip, will be deprecated in the future
created_date: 2025-06-02
script:
  - ./copy.sh # script to be executed
os: Linux # <Linux|Windows>

Operating System Support

The os field configuration will affect whether the package can be deployed to specific devices during deployment.

  • Linux: Linux systems only
  • Windows: Windows systems only

Sample Package

You can download a sample deploy package for reference and comparison:

📦 Download Sample Package

The downloaded sample deploy package is exactly the example mentioned above, demonstrating the configuration format and structure for copying expert images to a specified location on target devices.

call to action

Still Didn’t Find Your Answer?

Feel free to contact us for any questions or support needs. You could mail us at berniejk.liu@adlinktech.com