Sample Project (AtlasSample) Description

The directory structure and files of the sample project (AtlasSample) are described as follows. Refer to the implementation logic of the sample project to create your own development projects.

Default project sample directory:

├── build                                                    // Building directory
│   ├── build.sh                                            // Building script
├── config                                                   // Product configuration directory
│   ├──module_def                                           // Directory of the module configuration file
│   ├──project_cfg                                          // Directory for storing product configurations
│       ├──project.conf                                     // Product configuration file
├── output                                                   // Directory for storing the compiled version
├── platform                                                 // Path for storing om-sdk.tar.gz
└── src                                                      // Directory of user's incremental source code
     ├── app                                                 // Backend code directory
           ├── add_extend_fusion_director_interface         // Directory of new cloud-edge collaboration APIs
           ├── add_extend_restful_interface                 // Directory of new RESTful APIs
           ├── add_custom_define_cms_verify                  // Directory for building customized signature verification
           ├── add_extend_driver_adapter                     // Directory of new driver adapters
           ├── add_customized_alarm                          // Directory of new customized alarms
           ├── add_customized_config                        // Customized software configuration
           ├── add_extend_device                            // Customized peripheral configuration
           ├── set_customized_web_nav                        // Directory for dynamically loading components
           ├── build_customized_web_project                  // Directory for customized frontend compilation
           ├── add_customized_web_assets                     // Directory for configuring customized images and vendor information

Configuration File Description

The project_dir parameter involved in OM SDK development is the project directory. Replace it with your own project directory.

The configuration file path must be {project_dir}/config/project_cfg/project.conf. The _Vendor field in the configuration file is described as follows: Before development, enable the corresponding function of the configuration file.

_ProductName="xxx"                          # Change the value of _ProductName to your project name.
_Version="6.0.RC2"                            # Change the value of Version in the version.xml file.
_Vendor="custom-sdk"                        # Change the value of Vendor in the version.xml file, which cannot be huawei.
_Module="MindXOM"                           # Change the omsdk firmware type in the Module field in the version.xml file.
_NeedAdditionalDriver="no"                  # Development example of configuring the compilation and packaging module (optional, disabled by default).
_NeedAddExtendRestfulInterface="no"         # New RESTful API (optional, disabled by default).
_NeedAddExtendFusionDirectorInterface="no"  # New cloud-edge collaboration API (optional, disabled by default).
_NeedCustomizedWebAssets="no"               # Whether to configure customized images and vendor information (optional, disabled by default).
_NeedCustomizedWebNav="no"                  # Whether to dynamically load components (optional, disabled by default).
_NeedBuildCustomizedWeb="no"                # Customized frontend compilation (optional, disabled by default).
_NeedCustomizedAlarmCheck="no"              # Whether to configure customized alarms (optional, disabled by default).