Software Package Specifications

This section uses the software package om-sdk.tar.gz as an example to describe how to compile a custom software package.

The OM SDK allows users to compile installation packages for software that has undergone secondary development. In addition, the OM SDK provides a common upgrade channel for the OM SDK installation package and other custom firmware. Developers can compile a common upgrade package by referring to this section. The software package compiled by the OM SDK contains the following file information:

**Table 1** File information
File	File Description
omsdk.tar.gz	Software package name. You can customize the name of the upgrade package, but the name must be in tar.gz format.
vercfg.xml	Integrity verification file for the software package.
version.xml	Version configuration file.
vercfg.xml.cms	Signature file and CRL of the corresponding file.
vercfg.xml.crl
version.xml.cms
version.xml.crl
omsdk.tar.gz.cms
omsdk.tar.gz.crl

You need to prepare related files and ensure that the file names are the same as those in Table 2.

**Table 2** Files in the edge management system software package
File	File Description
bin	Necessary files for edge management system software running
config
lib
scripts
software
tools
install.sh	edge management system installation script
uninstall.sh	edge management system uninstallation script
upgrade.sh	edge management system upgrade script
version.xml	Version configuration file

Description of Key Files

The following is an example of the vercfg.xml file:

<?xml version="1.0" encoding="utf-8"?>
<Package>
    <File>
        <FilePath>version.xml</FilePath>
        <SHAValue>a28ed14f3bf81b7274ce090efd28dd2bf5313fd8e48809e4cdef27186d6ba654</SHAValue>
    </File>
    <File>
        <FilePath>omsdk.tar.gz</FilePath>
        <SHAValue>5a51030d5e7aead7e4c47408f9af11b4ff59bde0fc801b1290977b0e28322a04</SHAValue>
    </File>
</Package>

**Table 3** Parameter description
Parameter	Description
FilePath	File name in the upgrade package, which must contain the file name extension. The value can be version.xml or sdk-upgrade.tar.gz.
SHAValue	SHA-256 value of the file corresponding to the FilePath field. You can run the sha256sum command to obtain the value.

The following is an example of the version.xml file:

<?xml version="1.0" encoding="utf-8"?>
<FirmwarePackage version="V1">
<!--Upgrade packages description-->
    <Package>
        <FileName>omsdk.zip</FileName>
        <OutterName>MindXOM</OutterName>
       <Version>SDK-omsdk 1.0</Version>             
        <FileType>Firmware</FileType>
       <Module>SDK-omsdk</Module>                 
        <Vendor>Huawei Technologies Co., Ltd</Vendor>
        <MaxUpgradeTime>3600</MaxUpgradeTime>
        <!--UpgradeTimeout:unit second-->
        <ActiveMode>ResetOS</ActiveMode>
        <MaxActivetime>600</MaxActivetime>
        <SupportModel>Atlas 200I A2</SupportModel>
        <ProcessorArchitecture>ARM</ProcessorArchitecture>
        <UpgradeAgent>OM</UpgradeAgent>
    </Package>
</FirmwarePackage>

**Table 4** Parameter description
Parameter	Description
Version	Software package version, which can be configured during software package compilation.
Module	Firmware type of the software package, which can be configured during software package compilation.
Vendor	Vendor information, which can be configured during software package compilation.
FileName	Software package name, which can be configured during software package compilation.
OutterName	Mandatory configuration for the normal running of the edge management system software, which cannot be configured or modified.
FileType
MaxUpgradeTime
ActiveMode
MaxActivetime
SupportModel
ProcessorArchitecture
UpgradeAgent

Parent topic: Software Package Compilation