User Manual
Create installer for a System on a Chip device
This manual guides you through the process of creating a custom installer for your new awaBerry System-on-a-Chip (SoC) device. You will select a device, choose its internet connection method, configure the operating system, and finally submit the build job to receive a download link.
Create installer for a System on a Chip device
Summary
This page guides you through the multi-step process of preparing a custom installer image for your new awaBerry System-on-a-Chip (SoC) device. You will start by selecting a specific SoC device, either by searching or choosing from a list of available vendors and devices. Once your device is selected, you'll specify how it will connect to the internet (either via a wired network or Wi-Fi). If you choose Wi-Fi, you will be prompted to enter the network name and password. Finally, you will configure the operating system, including its version, desktop environment options, and whether to use a minimal build. After all configurations are complete, you will submit a job to create your personalized installer image, which will be sent to you via email.
Page Access
You can access this page by navigating to: /steps_newdevice_bespoke_soc
Page Functionalities
Step 1: Select your System-on-a-Chip device
- Device Search: A text field labeled "Search" allows you to find your device by typing its name. As you type, suggestions may appear.
- Vendor Selection: If you prefer to browse, a dropdown menu labeled "Select vendor" allows you to choose the manufacturer of your device.
- Device Selection: After selecting a vendor, another dropdown labeled "Select device" will appear, listing the available devices from that vendor.
- Selected Device Display: Once a device is chosen (either via search or selection), its name, vendor, and a description will be shown.
- Change Button: A "Change" button next to the selected device allows you to go back and choose a different device.
- Continue Button: After confirming your device selection, click "Continue" to proceed to the next step.
Step 2: Set internet access
- Selected Device Information: Displays the device you selected in the previous step, along with a "Change" option to go back and modify it.
- Wired Network Option: A tile labeled "via Wired network" allows you to choose a wired internet connection for your device.
- WLAN (WiFi) Option: A tile labeled "via WLAN (WiFi)" allows you to choose a wireless internet connection. Selecting this option will prompt you for Wi-Fi credentials in the next step.
Step 3: Provide Wi-Fi credentials (if WLAN was selected)
- Selected Device Information: Displays the device selected earlier. You can click "Change" to go back.
- Network Configuration: Shows that "Use WLAN" is selected, with a "Change" button to modify the connection type.
- Wi-Fi Name Input: A text field labeled "WIFI name" where you enter the name of your wireless network.
- Wi-Fi Password Input: A password field labeled "WIFI password" where you enter the password for your wireless network. This field has a "Show/Hide password" option.
- Continue Button: Click "Continue" to save your Wi-Fi details and proceed.
Step 4: Configure Operating System
- Selected Device Information: Displays the selected device, with a "Change" option.
- Network Configuration: Displays the chosen network configuration (e.g., "Use wired network" or "Use WLAN (YourWiFiName)"), with a "Change" option.
- Operating System Selection: A dropdown labeled "Please select the operating system in use:" to choose the OS for your device. Once selected, it displays as "Selected operating system" with a "Change" option.
- Version Selection: After selecting an OS, a dropdown labeled "Please select the version of the operating system" appears. Once selected, it displays as "Selected version" with a "Change" option.
- Desktop Version Selection: A dropdown labeled "Version with desktop" allows you to choose if the OS version should include a desktop environment. This is explained with a note: "If you plan to run the device as a server, select no. If you plan to run the device as a desktop PC, select yes." Once selected, it displays as "With desktop" with a "Change" option.
- Minimal Version Selection: A dropdown labeled "Use minimal version" allows you to choose a minimal build for server versions, explained as: "For server version, minimal version require less space on the SD card and have fewer pre-installed applications." Once selected, it displays as "Minimal version" with a "Change" option.
- Continue Button: After all configurations are made, click "Continue" to finalize your choices.
Step 5: Submit Build Job
- Job Description: A summary of your configured installer will be displayed under "Job description".
- Processing Indicator: A spinning indicator will show that your build job is being processed.
- Back to overview Button: Once the job is submitted (or if an error occurs), a "Back to overview" button appears to return to the main connection page.
- Error Message: If a job is already running, an error message "You have already a running job - please wait until it is done." will be displayed.
Scenario Executions
Possible usage steps within this page
Here are examples of how to successfully navigate and use this page:
Scenario: Full Installation with Wi-Fi Connection
- Select Device: Search for your desired SoC device (e.g., "Raspberry Pi 4") or select a vendor (e.g., "Raspberry Pi Foundation") and then a device from the dropdown.
- Continue: Click the "Continue" button.
- Select Wi-Fi: On the "Set internet access" page, tap the "via WLAN (WiFi)" tile.
- Enter Wi-Fi Credentials: Enter your Wi-Fi network name (e.g., "MyHomeNetwork") into the "WIFI name" field and its password (e.g., "MySecurePass123") into the "WIFI password" field.
- Continue: Click the "Continue" button.
- Configure OS: Select your desired Operating System (e.g., "Ubuntu") from the dropdown.
- Configure Version: Select the OS version (e.g., "22.04 LTS").
- Configure Desktop: Choose whether to include a desktop environment (e.g., "yes").
- Configure Minimal Version: Select if you want a minimal installation (e.g., "no").
- Continue: Click the "Continue" button to submit the build job.
- Job Submitted: Observe the job description and a success message indicating the job is submitted.
- Back to Overview: Click "Back to overview" to return to the main connection page.
Scenario: Full Installation with Wired Network Connection
- Select Device: Search for your desired SoC device (e.g., "Orange Pi 5") or select a vendor (e.g., "Radxa") and then a device from the dropdown.
- Continue: Click the "Continue" button.
- Select Wired Network: On the "Set internet access" page, tap the "via Wired network" tile.
- Configure OS: Select your desired Operating System (e.g., "Debian") from the dropdown.
- Configure Version: Select the OS version (e.g., "Bullseye").
- Configure Desktop: Choose whether to include a desktop environment (e.g., "no" for a server setup).
- Configure Minimal Version: Select if you want a minimal installation (e.g., "yes" for a server setup).
- Continue: Click the "Continue" button to submit the build job.
- Job Submitted: Observe the job description and a success message indicating the job is submitted.
- Back to Overview: Click "Back to overview" to return to the main connection page.
Possible errors which may occur on this page
Errors are typically indicated by red text messages directly below the input field or as a full-width error box at the top of a section.
Error: Missing Device Selection
If you click "Continue" on the "Select your system on a chip device" page without selecting a device from either the search field or the dropdowns, a message "Selected device" (or "Selected vendor" if applicable) will appear, prompting you to make a choice. This occurs because the system requires a specific device to proceed with the configuration.
Error: Reaching Device Limit
If you attempt to select a device but have already reached the maximum number of devices allowed by your current license, you will be redirected to an upgrade page with a message like "You have reached your device limit". This prevents you from configuring installers for more devices than your subscription permits.
Error: Missing Wi-Fi Credentials
If you select a Wi-Fi connection and then click "Continue" on the "Provide Wi-Fi credentials" page without entering a Wi-Fi name or password, error messages like "Please provide the name of your WIFI access point." or "Please provide the password of your WIFI access point." will appear. The system requires both details to correctly configure the installer for Wi-Fi access.
Error: Missing OS/Version/Desktop/Minimal Selection
If you click "Continue" on the "Configure Operating System" page without making a selection in any of the dropdowns (Operating System, Version, Desktop, Minimal Version), specific error messages (e.g., "Selected operating system", "Selected version", "With desktop", "Minimal version") will appear. Each of these configuration steps is mandatory to create a complete and functional installer.
Error: Job Already Running
If you try to submit a new build job while another job is still in progress for your account, a full-width error message will display: "You have already a running job - please wait until it is done.". The system only allows one build job to run at a time per user to manage resources efficiently.
