Build environment setup for ACU6 applications

Before diving into the build environment setup for your ACU6 application, it’s important to note that this guide presumes all prerequisite steps have been completed. For instance, it is assumed that your keystore is already signed. Our focus now shifts to guiding you through the setup of your build environment.

Download the Project Template

First, obtain the project template needed for ACU6 application development. You can download it here. This template is crucial for starting your project on the right foot.

Project File Structure Explained

Upon downloading, you will encounter the following structure in the project root:

project_root
├── externals
├── files
│   ├── sign.sh
│   ├── user-product-number.txt
│   └── user-software-version.txt
├── Makefile
└── sdk

  • sign.sh - A script for signing your application.

  • user-product-number.txt - Contains the product number information.

  • user-software-version.txt - Holds the software version details.

  • Makefile - Automates the build process.

  • sdk - The software development kit for ACU6.

Extracting the ACU6 SDK into Your Project

To ensure your ACU6 application is built with the right tools, the next crucial step is to extract the ACU6 SDK into the sdk folder of your project. This step is fundamental for accessing the full range of development features offered by the ACU6 platform.

SDK Extraction Process

  • Find the ACU6 SDK, which is typically named acu6-pro-sdk-vX.Y.Z.

  • Extract this SDK file into the sdk directory within your project’s root folder.

After extraction, your SDK directory should resemble the following structure:

sdk
└── acu6-pro-sdk-vX.Y.Z

Populating the Files Folder in Your ACU6 Project

A critical part of setting up your ACU6 application involves populating the ‘files’ folder with specific key files. This step is essential for authentication, security, and identification of your software on the ACU6 platform.

Detailed File Additions

  • Keys and Password Configuration: Place your private key (company-private.pem) and the signed keystore (company_keystore_acu6_dev.bpak) in this folder as they are. The device-password.txt should hold the device password.

  • User Software Identification: user-product-number.txt and user-software-version.txt are used to identify the software running on the ACU6 system. In this instance, you can leave them with their default values.

  • Files Directory Contents: Ensure your files directory includes the following:

    • company-private.pem - Your private key file.

    • company_keystore_acu6_dev.bpak - The signed keystore with your public key.

    • device-password.txt - Contains the device password.

    • sign.sh - A script for signing your applications.

    • user-product-number.txt - Identifies the product number.

    • user-software-version.txt - Indicates the software version.

The user software identification appears in the Device Manager.

Finalizing Setup with Docker

The last step in setting up your ACU6 application involves using Docker to create an environment for your project. This process is crucial for ensuring your application is ready for development and deployment.

Docker Image Creation

  • Navigate to your project’s root directory.

  • Run the command make docker-image-latest.

    • This step is essential immediately after setting up a new project or updating the SDK.

    • Note: It’s not necessary to run this command during intermediate stages unless there are significant changes or updates.