User Manual

Connect New Devices Mainpage

This page allows you to connect new devices to awaBerry or manage your ongoing device build requests. View the status of your bespoke installers, download them when ready, or start a new connection process.

Connect New Devices Mainpage

Summary

The 'Connect New Devices Mainpage' is your central hub for integrating new devices with awaBerry. Depending on your current activity, you will either see options to start connecting a new device, or a list of your custom installer requests (called 'bespoke build jobs'). You can track the progress of these jobs, download your installers and licenses once completed, or cancel requests that are still pending.

Add Device - how to connect

This page guides you through the initial step of connecting a device to your awaBerry account. Connecting your device allows you to access it remotely and utilize smart automation features. You will choose from several connection methods: connecting to a shared device, integrating an existing device, setting up a completely new device, or deploying a Docker container. The page also provides an overview of available installers for various device types.

Page Access

You can access this page by navigating to: /connect

Page Functionalities

Start Connecting Button: If no installer requests are active, this button initiates the step-by-step process to connect a new device to awaBerry.
Animated Wi-Fi Icon: When starting a new connection, an animated Wi-Fi icon visually indicates the system is ready to proceed with the connection steps.
Active Tickets for Building Bespoke Installer: This section appears if you have any custom installer requests. It lists each request with its specific details.
Refresh Ticket List Button: Located within the 'Active Tickets' section, this button allows you to manually update the status of your custom installer requests.
Add more devices Button: If you have active installer requests, this button allows you to initiate another device connection process.
Individual Build Job Details (Ticket, Status, Download Link Validity): For each custom installer request, you will see its unique ticket number, current status (e.g., 'Pending', 'In progress', 'Completed', 'Failed', 'Cancelled'), and if completed, when the download links will expire.
Download Installer Button: Appears for 'Completed' build jobs. Clicking this will download your custom device installer.
Download License Button: Appears for 'Completed' build jobs. Clicking this will download your device license file.
Cancel Ticket Link: For 'Pending' custom installer requests, this link allows you to cancel the job.
FAQ Link (How to write the installer to a USB stick or SD Card?): Provides a link to an external FAQ page with instructions on how to prepare your installer.

Scenario Executions

Possible usage steps within this page

Scenario 1: Starting a New Device Connection

Step 1: Arrive on the "Connect New Devices Mainpage".
Step 2: Observe that no active custom installer tickets are displayed.
Step 3: Locate and click the "Start connecting" button.
Expected Outcome: The system will clear any previous temporary connection settings and navigate you to the first step of the device connection guide.

Scenario 2: Viewing and Refreshing Custom Installer Requests

Step 1: Arrive on the "Connect New Devices Mainpage".
Step 2: See a list of "Active Tickets for Building Bespoke Installer".
Step 3: Review the status of your various tickets (e.g., 'Pending', 'In progress', 'Completed').
Step 4: Click the "Refresh ticket list" button.
Expected Outcome: Observe that the status of the tickets updates to reflect the latest information.

Scenario 3: Downloading a Completed Installer and License

Step 1: Arrive on the "Connect New Devices Mainpage".
Step 2: Locate a custom installer ticket with the status 'Completed'.
Step 3: Under this ticket, click the "Download installer" button.
Step 4: Your browser or device will prompt you to download the installer file.
Step 5: Also click the "Download license" button.
Expected Outcome: Your browser or device will prompt you to download the license file, providing you with the necessary files for your custom device installation.

Scenario 4: Canceling a Pending Custom Installer Request

Step 1: Arrive on the "Connect New Devices Mainpage".
Step 2: Locate a custom installer ticket with the status 'Pending'.
Step 3: Click the "Cancel ticket" link associated with that pending job.
Expected Outcome: The ticket status will change to 'Cancelled' (or disappear after system cleanup).

Scenario 5: Adding More Devices While Other Jobs Are Active

Step 1: Arrive on the "Connect New Devices Mainpage".
Step 2: See existing "Active Tickets for Building Bespoke Installer".
Step 3: Locate and click the "Add more devices" button.
Expected Outcome: The system will clear any temporary connection settings and navigate you to the first step of a new device connection guide, leaving your existing tickets untouched.

Scenario 6: Accessing the FAQ for Installer Writing

Step 1: Arrive on the "Connect New Devices Mainpage".
Step 2: Locate the "FAQ: How to write the installer to a USB stick or SD Card?" link at the bottom of the page.
Step 3: Click this link.
Expected Outcome: A new browser tab or window will open, displaying the awaBerry FAQ page with relevant instructions.

Possible errors which may occur on this page

Error: Download Links Not Available for Incomplete Jobs

Why it happens: You cannot download an installer or license until the custom build job is fully 'Completed'. The system needs time to prepare your specific files.
How to resolve: Regularly refresh the ticket list using the "Refresh ticket list" button. Once the status changes to 'Completed', the download buttons will appear.
What you see: Only a message like "Download installer possible if status is completed" instead of download buttons.

Error: Download Links Expire

Why it happens: For security and resource management, download links for completed installers and licenses are only valid for a limited time (e.g., 3 hours after completion). After this period, the system automatically deletes the ticket and files.
How to resolve: If your download links have expired, you will need to initiate a new custom installer request if you still require the files.
What you see: Download buttons might disappear or lead to an error page if clicked after expiration. The "Download link is valid until" message will help you track this.

Error: Unable to Cancel an In-Progress or Completed Ticket

Why it happens: Only 'Pending' custom installer requests can be cancelled. Once a job is 'In progress', the system is actively building your installer, and it cannot be stopped. Similarly, 'Completed' jobs are already finished.
How to resolve: You must wait for 'In progress' jobs to finish. For 'Completed' jobs, you can download the files or disregard them. If you no longer need a 'Pending' job, use the "Cancel ticket" link.
What you see: The "Cancel ticket" link will only appear for 'Pending' jobs.

Navigate ← awaBerry Device Management ← awaBerry User Manual Main Page