Create a bespoke installer -> Create installer for a System on a Chip device
Create installer for a System on a Chip device
Summary
This manual page explains how to use the 'Create installer for a System on a Chip device' feature within the Awaberry platform. It guides you through a step-by-step process to select your specific SoC device, configure its internet connection (wired or Wi-Fi), provide Wi-Fi credentials if needed, choose the operating system and its specific versions and desktop environments, and finally submit your custom installer build job. The goal is to create a tailored installer that automatically connects your new device to your Awaberry account.
Page Access
You can access this page by navigating to: /steps_newdevice_bespoke_soc
Page Functionalities
1. Select Device
- Search Field: Allows you to type and search for your device. As you type, suggestions appear.
- Vendor Dropdown: If you prefer to select from a list, choose the manufacturer of your device here.
- Device Dropdown: After selecting a vendor, choose your specific device from the list.
- Selected Device Display: Shows the name and vendor of your chosen device along with a brief description.
- "Change" Button: Appears after a device is selected, allowing you to go back and choose a different device.
- "Continue" Button: Proceeds to the next step after confirming your device selection.
2. Select Connection Type
- Selected Device Info: Re-confirms your chosen device.
- "Wired network" Tile: Select this if your device will connect to the internet using an Ethernet cable.
- "WLAN (WiFi)" Tile: Select this if your device will connect to the internet wirelessly. This will lead to the next step where you provide Wi-Fi details.
3. Enter Wi-Fi Credentials (if Wi-Fi selected)
This section appears if you chose "WLAN (WiFi)" in the previous step.
- Selected Device Info: Re-confirms your chosen device.
- Network Configuration Display: Shows that you chose "Use WLAN" and allows you to "Change" this setting.
- "WIFI name" Text Field: Enter the name of your Wi-Fi network (SSID).
- "WIFI password" Text Field: Enter the password for your Wi-Fi network. You can show/hide the password for verification.
- Error Message Box: Appears below the input fields if validation errors occur (e.g., missing information).
- "Continue" Button: Proceeds to the next step after entering valid Wi-Fi credentials.
4. Configure Operating System
- Selected Device Info: Re-confirms your chosen device.
- Network Configuration Display: Re-confirms your chosen network setup (wired or Wi-Fi).
- "Operating System" Dropdown: Select the operating system you want to install on your device (e.g., Linux, Android).
- "Version" Dropdown: After selecting an operating system, choose its specific version (e.g., Ubuntu 22.04 LTS, Android 13).
- "Version with desktop" Dropdown: Decide if you want a graphical desktop environment. Select "yes" for a typical desktop experience, "no" for a server or headless setup.
- "Use minimal version" Dropdown: Choose if you want a minimal installation of the operating system, which uses fewer resources.
- Selected Configuration Displays: As you make selections, your choices are shown, and you can "Change" them if you made a mistake.
- "Continue" Button: Proceeds to the final step after all configuration options are selected.
5. Submit Build Job
- Job Description Display: Shows a summary of the custom installer you're about to create, reflecting all your selections.
- Loading Indicator: Appears while your custom installer is being prepared by the system.
- Error Message Box: Appears if there's an issue with job submission (e.g., another job is already running).
- "Back to overview" Button: Appears after the job is successfully submitted or if an error occurs, taking you back to the main device connection overview page.
Scenario Executions
Possible usage steps within this page
1. Creating a custom Linux installer for a specific board with wired network
- Step 1 (Select Device):
- Search for "Raspberry Pi 4". Select the matching device from the suggestions.
- Click "Continue".
- Step 2 (Select Connection Type):
- Click the "via Wired network" tile.
- Step 3 (Configure Operating System):
- Select "Linux" from the "Operating System" dropdown.
- Select "Ubuntu 22.04 LTS" from the "Version" dropdown.
- Select "yes" from the "Version with desktop" dropdown.
- Select "no" from the "Use minimal version" dropdown.
- Click "Continue".
- Step 4 (Submit Build Job):
- Review the job description.
- The system will show a loading indicator and then a success message.
- You will be redirected to the overview page.
2. Creating a custom Android installer for a device with Wi-Fi network
- Step 1 (Select Device):
- Select "Google" from the "Select vendor" dropdown.
- Select "Coral Dev Board" from the "Select device" dropdown.
- Click "Continue".
- Step 2 (Select Connection Type):
- Click the "via WLAN (WiFi)" tile.
- Step 3 (Enter Wi-Fi Credentials):
- In "WIFI name", enter "MyHomeNetwork".
- In "WIFI password", enter "MySecurePass123!".
- Click "Continue".
- Step 4 (Configure Operating System):
- Select "Android" from the "Operating System" dropdown.
- Select "Android 13" from the "Version" dropdown.
- Select "yes" from the "Version with desktop" dropdown.
- Select "no" from the "Use minimal version" dropdown.
- Click "Continue".
- Step 5 (Submit Build Job):
- Review the job description.
- The system will show a loading indicator and then a success message.
- You will be redirected to the overview page.
Possible errors which may occur on this page
1. "Please provide the name of your WIFI access point."
Cause: This error appears on the "Enter Wi-Fi Credentials" page if you attempt to proceed without entering a name in the "WIFI name" field.
How to resolve: Enter the name (SSID) of your Wi-Fi network into the "WIFI name" text field.
2. "Please provide the password of your WIFI access point."
Cause: This error appears on the "Enter Wi-Fi Credentials" page if you attempt to proceed without entering a password in the "WIFI password" field.
How to resolve: Enter the password for your Wi-Fi network into the "WIFI password" text field.
3. "You have already a running job - please wait until it is done."
Cause: This error occurs on the "Submit Build Job" page if you try to submit a new installer build request while another one is already actively being processed by the system.
How to resolve: Wait for the currently running job to complete. You can usually monitor the status of your jobs on the main overview page. Once the previous job is finished, you can submit a new one.
